com.hp.mercury.ci.jenkins.plugins.oo.utils

Enum CharacterRange

java.lang.Object

java.lang.Enum<CharacterRange>

com.hp.mercury.ci.jenkins.plugins.oo.utils.CharacterRange

All Implemented Interfaces:

Serializable, Comparable<CharacterRange>, Iterable<Character>

public enum CharacterRange
extends Enum<CharacterRange>
implements Iterable<Character>

enum with several common character ranges. useful for input validation, uid generation, text transformations etc...

Enum Constant Summary

Enum Constants

Enum Constant and Description
LowercaseAlphabetic represents the lower-case alphabetical range a-z
Numeric represents the 0-9 numeric range
UppercaseAlphabetic represents the upper-case alphabetical range A-Z

Method Summary

Methods

Modifier and Type	Method and Description
char	getFirstLetter()
char	getLastLetter()
int	getLength()
Iterator<Character>	iterator()
static CharacterRange	valueOf(String name) Returns the enum constant of this type with the specified name.
static CharacterRange[]	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

Numeric

public static final CharacterRange Numeric

represents the 0-9 numeric range

LowercaseAlphabetic

public static final CharacterRange LowercaseAlphabetic

represents the lower-case alphabetical range a-z

UppercaseAlphabetic

public static final CharacterRange UppercaseAlphabetic

represents the upper-case alphabetical range A-Z

Method Detail

values

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

Returns:

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

valueOf

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

getFirstLetter

public char getFirstLetter()

Returns:

firstLetter

getLastLetter

public char getLastLetter()

Returns:

lastLetter

getLength

public int getLength()

Returns:

the size of this range

iterator

public Iterator<Character> iterator()

Specified by:

iterator in interface Iterable<Character>

Returns:

an iterator that iterates this range's elements