Package org.passay

Class RuleResultMetadata

java.lang.Object

org.passay.RuleResultMetadata

public final class RuleResultMetadata
extends Object

Describes metadata relevant to the result of rule validation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RuleResultMetadata.CountCategory	Count category.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<RuleResultMetadata.CountCategory,Integer>	counts	Character count metadata.

Constructor Summary

Constructors

Constructor	Description
RuleResultMetadata()	Creates a new rule result metadata.
RuleResultMetadata(List<RuleResultMetadata> metadata)	Creates a new rule result metadata.
RuleResultMetadata(RuleResultMetadata metadata)	Creates a new rule result metadata.
RuleResultMetadata(RuleResultMetadata.CountCategory category, int value)	Creates a new rule result metadata.

Method Summary

Modifier and Type	Method	Description
int	getCount(RuleResultMetadata.CountCategory category)	Returns the count for the supplied category.
Map<RuleResultMetadata.CountCategory,Integer>	getCounts()	Returns an unmodifiable map of all count metadata.
boolean	hasCount(RuleResultMetadata.CountCategory category)	Returns whether a count exists for the supplied category.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

counts

private final Map<RuleResultMetadata.CountCategory,Integer> counts

Character count metadata.

Constructor Details

RuleResultMetadata

public RuleResultMetadata()

Creates a new rule result metadata.

RuleResultMetadata

public RuleResultMetadata(RuleResultMetadata.CountCategory category,
 int value)

Creates a new rule result metadata.

Parameters:

category - count category.

value - count value.

RuleResultMetadata

public RuleResultMetadata(RuleResultMetadata metadata)

Creates a new rule result metadata.

Parameters:

metadata - to copy.

RuleResultMetadata

public RuleResultMetadata(List<RuleResultMetadata> metadata)

Creates a new rule result metadata.

Parameters:

metadata - to copy.

Method Details

hasCount

public boolean hasCount(RuleResultMetadata.CountCategory category)

Returns whether a count exists for the supplied category.

Parameters:

category - of the count.

Returns:

whether a count exists.

getCount

public int getCount(RuleResultMetadata.CountCategory category)

Returns the count for the supplied category.

Parameters:

category - of the count.

Returns:

character count.

getCounts

public Map<RuleResultMetadata.CountCategory,Integer> getCounts()

Returns an unmodifiable map of all count metadata.

Returns:

count metadata.

toString

public String toString()

Overrides:

toString in class Object