Package adams.core

Enum ShorteningType

java.lang.Object

java.lang.Enum<ShorteningType>

adams.core.ShorteningType

All Implemented Interfaces:

Serializable, Comparable<ShorteningType>

public enum ShorteningType
extends Enum<ShorteningType>

Determines where to shorten the comments.

Version:

$Revision: 12678 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
END
MIDDLE
NONE
START

Method Summary

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

START

public static final ShorteningType START

MIDDLE

public static final ShorteningType MIDDLE

END

public static final ShorteningType END

Method Detail

values

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

Returns:

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

valueOf

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