Module org.basinmc.lavatory

Package org.basinmc.lavatory.rule

Class AbstractRuleControlledResource

java.lang.Object

org.basinmc.lavatory.rule.AbstractRuleControlledResource

All Implemented Interfaces:

RuleControlledResource

Direct Known Subclasses:

LibraryReference, ProgramArgument

public abstract class AbstractRuleControlledResource
extends Object
implements RuleControlledResource

Provides an abstract base to resources which are included based on whether their rules (if any) match.

Author:

Johannes Donath

Constructor Summary

Constructors

Constructor	Description
AbstractRuleControlledResource(Set<Rule> rules)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	evaluate(ResolverContext ctx)	Evaluates whether the resource is to be included in the final result.
Set<Rule>	getRules()	Retrieves the internal set of rules which apply to this particular resource.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRuleControlledResource

public AbstractRuleControlledResource(@Nullable
                                      Set<Rule> rules)

Method Detail

getRules

@NonNull
public Set<Rule> getRules()

Retrieves the internal set of rules which apply to this particular resource.

Specified by:

getRules in interface RuleControlledResource

Returns:

a set of rules.

evaluate

public boolean evaluate(@NonNull
                        ResolverContext ctx)

Evaluates whether the resource is to be included in the final result.

Specified by:

evaluate in interface RuleControlledResource

Parameters:

ctx - a context.

Returns:

true if inclusion is permitted, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object