com.stormpath.sdk.impl.query

Enum MatchLocation

java.lang.Object

java.lang.Enum<MatchLocation>

com.stormpath.sdk.impl.query.MatchLocation

All Implemented Interfaces:

Serializable, Comparable<MatchLocation>

public enum MatchLocation
extends Enum<MatchLocation>

Since:

0.8

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANYWHERE Match the search text anywhere in the field or fields being searched.
BEGIN Match the search text at the beginning of the field or fields being searched.
END Match the search text at the end of the field or fields being searched.

Method Summary

Methods

Modifier and Type	Method and Description
String	toMatchString(String pattern)
abstract String	toMatchString(String pattern, String delimiter)
static MatchLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static MatchLocation[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BEGIN

public static final MatchLocation BEGIN

Match the search text at the beginning of the field or fields being searched.

END

public static final MatchLocation END

Match the search text at the end of the field or fields being searched.

ANYWHERE

public static final MatchLocation ANYWHERE

Match the search text anywhere in the field or fields being searched.

Method Detail

values

public static MatchLocation[] 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 (MatchLocation c : MatchLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static MatchLocation 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

toMatchString

public String toMatchString(String pattern)

toMatchString

public abstract String toMatchString(String pattern,
                   String delimiter)