Package org.passay

Class AbstractRuleResult

java.lang.Object

org.passay.AbstractRuleResult

All Implemented Interfaces:

RuleResult

Direct Known Subclasses:

FailureRuleResult, SuccessRuleResult

public abstract class AbstractRuleResult
extends Object
implements RuleResult

Base class for rule results.

Field Summary

Fields

Modifier and Type	Field	Description
private final RuleResultMetadata	metadata	Metadata produced by a password rule.
private final boolean	valid	Whether password rule was successful.

Constructor Summary

Constructors

Constructor	Description
AbstractRuleResult(boolean valid, RuleResultMetadata metadata)	Creates a new abstract rule result.

Method Summary

Modifier and Type	Method	Description
List<RuleResultDetail>	getDetails()	Returns any details associated with the rule verification.
RuleResultMetadata	getMetadata()	Returns metadata associated with the rule verification.
boolean	isValid()	Returns whether the result of the rule verification is a valid password.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

valid

private final boolean valid

Whether password rule was successful.

metadata

private final RuleResultMetadata metadata

Metadata produced by a password rule.

Constructor Details

AbstractRuleResult

public AbstractRuleResult(boolean valid,
 RuleResultMetadata metadata)

Creates a new abstract rule result.

Parameters:

valid - result validity

metadata - associated by the rule with the password

Method Details

isValid

public boolean isValid()

Description copied from interface: RuleResult

Returns whether the result of the rule verification is a valid password.

Specified by:

isValid in interface RuleResult

Returns:

valid password for this rule

getMetadata

public RuleResultMetadata getMetadata()

Description copied from interface: RuleResult

Returns metadata associated with the rule verification.

Specified by:

getMetadata in interface RuleResult

Returns:

rule result metadata

getDetails

public List<RuleResultDetail> getDetails()

Description copied from interface: RuleResult

Returns any details associated with the rule verification.

Specified by:

getDetails in interface RuleResult

Returns:

rule result details

toString

public String toString()

Overrides:

toString in class Object