Package de.hsh.graja.comment.applicability

Class AudienceFilter

java.lang.Object

de.hsh.graja.comment.applicability.ApplicabilityFilter

de.hsh.graja.comment.applicability.AudienceFilter

All Implemented Interfaces:

IncludeInfo, Serializable

public class AudienceFilter
extends ApplicabilityFilter

This class can filter artifacts with an applicablity depending on the audience. If you want to construct more complex filters, have a look at ApplicabilityFilterChain.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final AudienceFilter	STUDENT_OR_BOTH	This filter lets pass all artifacts with audience Audience.STUDENT or Audience.BOTH.
static final AudienceFilter	TEACHER_OR_BOTH	This filter lets pass all artifacts with audience Audience.TEACHER or Audience.BOTH.

Fields inherited from class de.hsh.graja.comment.applicability.ApplicabilityFilter

PASS_ALL

Constructor Summary

Constructors

Constructor	Description
AudienceFilter(Audience audience)	Create a filter, that lets pass all artifacts, whose audience is broader than or equals to the given audience.

Method Summary

Modifier and Type	Method	Description
boolean	passesThrough(Applicability applicability)	This method checks, whether a artifact with given applicability would pass the filter.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TEACHER_OR_BOTH

public static final AudienceFilter TEACHER_OR_BOTH

This filter lets pass all artifacts with audience Audience.TEACHER or Audience.BOTH.

STUDENT_OR_BOTH

public static final AudienceFilter STUDENT_OR_BOTH

This filter lets pass all artifacts with audience Audience.STUDENT or Audience.BOTH.

Constructor Details

AudienceFilter

public AudienceFilter(Audience audience)

Create a filter, that lets pass all artifacts, whose audience is broader than or equals to the given audience.

Parameters:

audience - specifies the passing artifacts.

Method Details

passesThrough

public boolean passesThrough(Applicability applicability)

Description copied from class: ApplicabilityFilter

This method checks, whether a artifact with given applicability would pass the filter.

Specified by:

passesThrough in class ApplicabilityFilter

Parameters:

applicability - the query applicability

Returns:

true, if the parameter applicability is broader than or equal to the audience represented by this filter.

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation