org.passay

Enum MatchBehavior

java.lang.Object

java.lang.Enum<MatchBehavior>

org.passay.MatchBehavior

All Implemented Interfaces:

Serializable, Comparable<MatchBehavior>

public enum MatchBehavior
extends Enum<MatchBehavior>

Enum that defines how string matching should occur.

Author:

Middleware Services

Enum Constant Summary

Enum Constants

Enum Constant and Description
Contains Use String.contains(CharSequence).
EndsWith Use String.endsWith(String).
StartsWith Use String.startsWith(String).

Method Summary

Modifier and Type	Method and Description
boolean	match(String text, char c) Returns whether text matches the supplied string for this match type.
boolean	match(String text, String 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 Detail

StartsWith

public static final MatchBehavior StartsWith

Use String.startsWith(String).

EndsWith

public static final MatchBehavior EndsWith

Use String.endsWith(String).

Contains

public static final MatchBehavior Contains

Use String.contains(CharSequence).

Method Detail

values

public static MatchBehavior[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatchBehavior c : MatchBehavior.values())
    System.out.println(c);

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(String text,
                     char c)

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

Parameters:

text - to search

c - to find in text

Returns:

whether text matches the supplied string for this match type

match

public boolean match(String text,
                     String 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>