com.saperion.jcs.modules.users.api

Enum DescriptorComparison

java.lang.Object

java.lang.Enum<DescriptorComparison>

com.saperion.jcs.modules.users.api.DescriptorComparison

All Implemented Interfaces:

Serializable, Comparable<DescriptorComparison>

public enum DescriptorComparison
extends Enum<DescriptorComparison>

The Enum DescriptorComparison.

Symbolizes the comparison of a SQL clause e.g. "=", "LIKE", "IN" or "IS NULL". Used by the SearchOptions and com.sapertion.jcs.modules.users.NativeUserService to build a generic SQl query.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUAL Equal comparison "=".
IN The in.
LIKE Like comparison "LIKE".
NULL Is null comparison "IS NULL".

Method Summary

Methods

Modifier and Type	Method and Description
String	getComparison() Gets the comparison.
static DescriptorComparison	valueOf(String name) Returns the enum constant of this type with the specified name.
static DescriptorComparison[]	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

EQUAL

public static final DescriptorComparison EQUAL

Equal comparison "=".

LIKE

public static final DescriptorComparison LIKE

Like comparison "LIKE".

NULL

public static final DescriptorComparison NULL

Is null comparison "IS NULL".

IN

public static final DescriptorComparison IN

The in.

Method Detail

values

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

Returns:

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

valueOf

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

getComparison

public String getComparison()

Gets the comparison.

Returns:

the comparison