Package org.passay.rule

Enum MatchBehavior

java.lang.Object

java.lang.Enum<MatchBehavior>

org.passay.rule.MatchBehavior

All Implemented Interfaces:

Serializable, Comparable<MatchBehavior>

public enum MatchBehavior
extends Enum<MatchBehavior>

Enum that defines how string matching should occur.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Contains	Use UnicodeString.contains(UnicodeString).
EndsWith	Use UnicodeString.endsWith(UnicodeString).
StartsWith	Use UnicodeString.startsWith(UnicodeString).

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description	The description of the match behavior.
private final BiFunction<UnicodeString,UnicodeString,Boolean>	matcher	The matcher function.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MatchBehavior(String desc, BiFunction<UnicodeString,UnicodeString,Boolean> matcherFunction)	Constructs a MatchBehavior constant.

Method Summary

Modifier and Type	Method	Description
boolean	match(UnicodeString text, int cp)	Returns whether text matches the supplied string for this match type.
boolean	match(UnicodeString text, CharSequence s)	Returns whether text matches the supplied string for this match type.
boolean	match(UnicodeString text, UnicodeString s)	Returns whether text matches the supplied string for this match type.
String	toString()
String	upperSnakeName()	Returns the name of this match behavior in upper case snake casing.
static MatchBehavior	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MatchBehavior[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

StartsWith

public static final MatchBehavior StartsWith

Use UnicodeString.startsWith(UnicodeString).

EndsWith

public static final MatchBehavior EndsWith

Use UnicodeString.endsWith(UnicodeString).

Contains

public static final MatchBehavior Contains

Use UnicodeString.contains(UnicodeString).

Field Details

description

private final String description

The description of the match behavior.

matcher

private final BiFunction<UnicodeString,UnicodeString,Boolean> matcher

The matcher function.

Constructor Details

MatchBehavior

private MatchBehavior(String desc,
 BiFunction<UnicodeString,UnicodeString,Boolean> matcherFunction)

Constructs a MatchBehavior constant.

Parameters:

desc - the behavior description

matcherFunction - the matcher function

Method Details

values

public static MatchBehavior[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatchBehavior valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

upperSnakeName

public String upperSnakeName()

Returns the name of this match behavior in upper case snake casing.

Returns:

upper case snake name

match

public boolean match(UnicodeString text,
 int cp)

Returns whether text matches the supplied string for this match type.

Parameters:

text - to search

cp - code point to find in text

Returns:

whether text matches the supplied string for this match type

match

public boolean match(UnicodeString text,
 CharSequence s)

Returns whether text matches the supplied string for this match type.

Parameters:

text - to search

s - to find in text

Returns:

whether text matches the supplied string for this match type

match

public boolean match(UnicodeString text,
 UnicodeString s)

Returns whether text matches the supplied string for this match type.

Parameters:

text - to search

s - to find in text

Returns:

whether text matches the supplied string for this match type

toString

public String toString()

Overrides:

toString in class Enum<MatchBehavior>