sailpoint.object

Enum Filter.MatchMode

java.lang.Object

java.lang.Enum<Filter.MatchMode>

sailpoint.object.Filter.MatchMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Filter.MatchMode>

Enclosing class:

Filter

public static enum Filter.MatchMode
extends java.lang.Enum<Filter.MatchMode>

An enumeration that describes how to match strings in a 'like' filter.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANYWHERE Match anywhere within a String - equivalent to contains().
END Match the end a String - equivalent to endsWith().
EXACT Match an exact String - equivalent to equals().
START Match the start of a String - equivalent to startsWith().

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	toMatchString(java.lang.String value, java.lang.String wildcard) Convert the given value into a match string using the given wildcard.
static Filter.MatchMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Filter.MatchMode[]	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

ANYWHERE

public static final Filter.MatchMode ANYWHERE

Match anywhere within a String - equivalent to contains().

START

public static final Filter.MatchMode START

Match the start of a String - equivalent to startsWith().

END

public static final Filter.MatchMode END

Match the end a String - equivalent to endsWith().

EXACT

public static final Filter.MatchMode EXACT

Match an exact String - equivalent to equals().

Method Detail

values

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

Returns:

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

valueOf

public static Filter.MatchMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toMatchString

public abstract java.lang.String toMatchString(java.lang.String value,
                                               java.lang.String wildcard)

Convert the given value into a match string using the given wildcard.

Parameters:

value - The value for which to retrieve the match string.

wildcard - The wildcard to use.

Returns:

A match string of the given value using the given wildcard.