org.refcodes.data

Enum Prefix

java.lang.Object

java.lang.Enum<Prefix>

org.refcodes.data.Prefix

All Implemented Interfaces:

Serializable, Comparable<Prefix>, org.refcodes.mixin.PrefixAccessor

public enum Prefix
extends Enum<Prefix>
implements org.refcodes.mixin.PrefixAccessor

Commonly used characters needful for analyzing, parsing or truncating texts.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.PrefixAccessor

org.refcodes.mixin.PrefixAccessor.PrefixBuilder<B extends org.refcodes.mixin.PrefixAccessor.PrefixBuilder<B>>, org.refcodes.mixin.PrefixAccessor.PrefixMutator, org.refcodes.mixin.PrefixAccessor.PrefixProperty

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCRYPTED
LONG_ARG_OPTION A command line argument (POSIX) long-option is prefixed with a double hyphen-minus "--".
SHORT_ARG_OPTION A command line argument (POSIX) short-option is prefixed with a single hyphen-minus "-".

Method Summary

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

ENCRYPTED

public static final Prefix ENCRYPTED

SHORT_ARG_OPTION

public static final Prefix SHORT_ARG_OPTION

A command line argument (POSIX) short-option is prefixed with a single hyphen-minus "-".

LONG_ARG_OPTION

public static final Prefix LONG_ARG_OPTION

A command line argument (POSIX) long-option is prefixed with a double hyphen-minus "--".

Method Detail

values

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

Returns:

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

valueOf

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

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface org.refcodes.mixin.PrefixAccessor