Package de.hsh.graja.comment.applicability

Class ApplicabilitySpec

java.lang.Object

de.hsh.graja.comment.applicability.ApplicabilitySpec

All Implemented Interfaces:

IncludeSpec, Serializable

public final class ApplicabilitySpec
extends Object
implements IncludeSpec

An instance of this class specifies a comment's own Applicability together with the applicabilities of depended on comments (ApplicabilityDependency). Once created, the dependencies cannot be modified.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ApplicabilitySpec	ALL_BOTH
static final ApplicabilitySpec	ALL_STUDENT
static final ApplicabilitySpec	ALL_TEACHER
static final ApplicabilitySpec	FINE_BOTH
static final ApplicabilitySpec	FINE_STUDENT
static final ApplicabilitySpec	FINE_TEACHER
static final ApplicabilitySpec	FINER_BOTH
static final ApplicabilitySpec	FINER_STUDENT
static final ApplicabilitySpec	FINER_TEACHER
static final ApplicabilitySpec	INFO_BOTH
static final ApplicabilitySpec	INFO_STUDENT
static final ApplicabilitySpec	INFO_TEACHER
static final ApplicabilitySpec	SEVERE_BOTH
static final ApplicabilitySpec	SEVERE_STUDENT
static final ApplicabilitySpec	SEVERE_TEACHER
static final ApplicabilitySpec	WARNING_BOTH
static final ApplicabilitySpec	WARNING_STUDENT
static final ApplicabilitySpec	WARNING_TEACHER

Method Summary

Modifier and Type	Method	Description
Applicability	calcApplicability(ApplicabilityFilter filter, boolean followDependencies)
static ApplicabilitySpec	create(Applicability own, ApplicabilityDependency dependency)
static ApplicabilitySpec	dep(ApplicabilityDependency dep)
boolean	equals(Object obj)	implements the contract of Object.equals(Object).
ApplicabilityDependency	getDependencyClone()
Class<? extends ApplicabilityDependency>	getDependencyType()
Applicability	getOwn()
int	hashCode()	implements the contract of Object.hashCode().
boolean	include(IncludeInfo info)
static ApplicabilitySpec	own(Level lvl, Audience aud)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SEVERE_TEACHER

public static final ApplicabilitySpec SEVERE_TEACHER

SEVERE_STUDENT

public static final ApplicabilitySpec SEVERE_STUDENT

SEVERE_BOTH

public static final ApplicabilitySpec SEVERE_BOTH

WARNING_TEACHER

public static final ApplicabilitySpec WARNING_TEACHER

WARNING_STUDENT

public static final ApplicabilitySpec WARNING_STUDENT

WARNING_BOTH

public static final ApplicabilitySpec WARNING_BOTH

INFO_TEACHER

public static final ApplicabilitySpec INFO_TEACHER

INFO_STUDENT

public static final ApplicabilitySpec INFO_STUDENT

INFO_BOTH

public static final ApplicabilitySpec INFO_BOTH

FINE_TEACHER

public static final ApplicabilitySpec FINE_TEACHER

FINE_STUDENT

public static final ApplicabilitySpec FINE_STUDENT

FINE_BOTH

public static final ApplicabilitySpec FINE_BOTH

FINER_TEACHER

public static final ApplicabilitySpec FINER_TEACHER

FINER_STUDENT

public static final ApplicabilitySpec FINER_STUDENT

FINER_BOTH

public static final ApplicabilitySpec FINER_BOTH

ALL_TEACHER

public static final ApplicabilitySpec ALL_TEACHER

ALL_STUDENT

public static final ApplicabilitySpec ALL_STUDENT

ALL_BOTH

public static final ApplicabilitySpec ALL_BOTH

Method Details

getOwn

public Applicability getOwn()

Returns:

own applicability of the spec object

getDependencyType

public Class<? extends ApplicabilityDependency> getDependencyType()

Returns:

type of the dependency of the spec object (or null, if dependency is null)

getDependencyClone

public ApplicabilityDependency getDependencyClone()

Returns:

clone of the dependency of the spec object (or null, if dependency is null)

calcApplicability

public Applicability calcApplicability(ApplicabilityFilter filter,
 boolean followDependencies)

Returns:

returns the applicability of the union of own applicability and (if followDependencies is true) depended on applicabilities

dep

public static ApplicabilitySpec dep(ApplicabilityDependency dep)

Parameters:

dep - dependency

Returns:

a new spec with minimum own applicability and the given dep as dependency

own

public static ApplicabilitySpec own(Level lvl,
 Audience aud)

Parameters:

lvl - own level

aud - own audience

Returns:

a new spec with no dependency and the given lvl and aud as own applicability.

create

public static ApplicabilitySpec create(Applicability own,
 ApplicabilityDependency dependency)

Parameters:

own - own applicability

dependency - dependency will be cloned internally, so the dependency will not be modifiable afterwards.

Returns:

a new spec with given values

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

hashCode

public int hashCode()

implements the contract of Object.hashCode().

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

implements the contract of Object.equals(Object).

Overrides:

equals in class Object

include

public boolean include(IncludeInfo info)

Specified by:

include in interface IncludeSpec