Package de.hsh.graja.comment.applicability

Class Applicability

java.lang.Object

de.hsh.graja.comment.applicability.Applicability

All Implemented Interfaces:

Applicable, Serializable

public final class Applicability
extends Object
implements Applicable

A pair of Level and Audience.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Applicability	MAXIMUM_APPLICABILITY	Applicability with level Level.SEVERE and audience Audience.BOTH.
static Applicability	MINIMUM_APPLICABILITY	Applicability with level Level.ALL and audience Audience.NONE.

Constructor Summary

Constructors

Constructor	Description
Applicability(Level level, Audience audience)	Create an instance

Method Summary

Modifier and Type	Method	Description
Applicability	calcApplicability(ApplicabilityFilter filter)	Calculate the applicability of a comment or for referenced comments (so called dependencies).
boolean	equals(Object obj)	implements the contract of Object.equals(Object).
Audience	getAudience()
Level	getLevel()
int	hashCode()	implements the contract of Object.hashCode().
static Applicability	intersection(Applicability[] applicabilities)	Returns the lowest (= least severe level / smallest audience) applicability of given applicability
static Applicability	intersection(Applicability a, Applicability b)	Returns the lower (= less severe level / smaller audience) applicability of a and b
boolean	isMaximum()
boolean	isMinimum()
String	toString()
static Applicability	union(Applicability[] applicabilities)	Returns the highest (= most severe level / broadest audience) applicability of given applicabilities.
static Applicability	union(Applicability a, Applicability b)	Returns the higher (= more severe level / broader audience) applicability of a and b

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_APPLICABILITY

public static final Applicability MAXIMUM_APPLICABILITY

Applicability with level Level.SEVERE and audience Audience.BOTH.

MINIMUM_APPLICABILITY

public static final Applicability MINIMUM_APPLICABILITY

Applicability with level Level.ALL and audience Audience.NONE.

Constructor Detail

Applicability

public Applicability(Level level,
                     Audience audience)

Create an instance

Parameters:

level - level

audience - audience

Method Detail

getLevel

public Level getLevel()

Returns:

level

getAudience

public Audience getAudience()

Returns:

audiencne

toString

public String toString()

Overrides:

toString in class Object

Returns:

string representation

isMinimum

public boolean isMinimum()

Returns:

true, if this applicability equals MINIMUM_APPLICABILITY.

isMaximum

public boolean isMaximum()

Returns:

true, if this applicability equals MAXIMUM_APPLICABILITY.

union

public static Applicability union(Applicability a,
                                  Applicability b)

Returns the higher (= more severe level / broader audience) applicability of a and b

Parameters:

a - one applicability

b - another applicability

Returns:

the higher applicability of the two parameters

intersection

public static Applicability intersection(Applicability a,
                                         Applicability b)

Returns the lower (= less severe level / smaller audience) applicability of a and b

Parameters:

a - one applicability

b - another applicability

Returns:

the lower applicability of the two parameters

intersection

public static Applicability intersection(Applicability[] applicabilities)

Returns the lowest (= least severe level / smallest audience) applicability of given applicability

Parameters:

applicabilities - given applicabilities

Returns:

lowest applicability

union

public static Applicability union(Applicability[] applicabilities)

Returns the highest (= most severe level / broadest audience) applicability of given applicabilities.

Parameters:

applicabilities - given applicabilities

Returns:

highest applicability

calcApplicability

public Applicability calcApplicability(ApplicabilityFilter filter)

Description copied from interface: Applicable

Calculate the applicability of a comment or for referenced comments (so called dependencies). The calculated applicability might result from a union or intersection of grouped dependencies. The calculation leaves out artifacts that do not pass the given filter. If no applicability can be calculated, because all relevant artifacts are filtered out, MINIMUM_APPLICABILITY is returned.

Specified by:

calcApplicability in interface Applicable

Parameters:

filter - filter

Returns:

this, if this applicability passes the given filter. Otherwise MINIMUM_APPLICABILITY.

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