org.josef.util

Enum Trim

java.lang.Object

java.lang.Enum<Trim>

org.josef.util.Trim

All Implemented Interfaces:

Serializable, Comparable<Trim>

@Status(stage=PRODUCTION)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public enum Trim
extends Enum<Trim>

Enumeration of all possibles ways to trim characters from a String.

Version:

1.0 $Revision: 3753 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All (Trim all characters from a String).
BOTH Both (Trim Left and Right).
LEFT Left.
RIGHT Right.

Method Summary

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

LEFT

public static final Trim LEFT

Left.

RIGHT

public static final Trim RIGHT

Right.

BOTH

public static final Trim BOTH

Both (Trim Left and Right).

ALL

public static final Trim ALL

All (Trim all characters from a String).

Method Detail

values

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

Returns:

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

valueOf

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