org.ldaptive.handler

Enum CaseChangeEntryHandler.CaseChange

java.lang.Object

java.lang.Enum<CaseChangeEntryHandler.CaseChange>

org.ldaptive.handler.CaseChangeEntryHandler.CaseChange

All Implemented Interfaces:

Serializable, Comparable<CaseChangeEntryHandler.CaseChange>

Enclosing class:

CaseChangeEntryHandler

public static enum CaseChangeEntryHandler.CaseChange
extends Enum<CaseChangeEntryHandler.CaseChange>

Enum to define the type of case change.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOWER lower case.
NONE no case change.
UPPER upper case.

Method Summary

Modifier and Type	Method and Description
static String	perform(CaseChangeEntryHandler.CaseChange cc, String string) This changes the supplied string based on the supplied case change.
static CaseChangeEntryHandler.CaseChange	valueOf(String name) Returns the enum constant of this type with the specified name.
static CaseChangeEntryHandler.CaseChange[]	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

NONE

public static final CaseChangeEntryHandler.CaseChange NONE

no case change.

LOWER

public static final CaseChangeEntryHandler.CaseChange LOWER

lower case.

UPPER

public static final CaseChangeEntryHandler.CaseChange UPPER

upper case.

Method Detail

values

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

Returns:

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

valueOf

public static CaseChangeEntryHandler.CaseChange 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

perform

public static String perform(CaseChangeEntryHandler.CaseChange cc,
                             String string)

This changes the supplied string based on the supplied case change.

Parameters:

cc - case change to perform

string - to modify

Returns:

string that has been changed