com.phloc.commons.changelog

Enum EChangeLogAction

java.lang.Object

java.lang.Enum<EChangeLogAction>

com.phloc.commons.changelog.EChangeLogAction

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EChangeLogAction>

public enum EChangeLogAction
extends Enum<EChangeLogAction>
implements IHasID<String>

Represents the possible actions in a change log.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD
CHANGE
FIX
REMOVE
UPDATE

Method Summary

Methods

Modifier and Type	Method and Description
static EChangeLogAction	getFromIDOrDefault(String sID, EChangeLogAction eDefault)
static EChangeLogAction	getFromIDOrNull(String sID)
String	getID() Get the unique ID of this object.
static EChangeLogAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static EChangeLogAction[]	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

ADD

public static final EChangeLogAction ADD

REMOVE

public static final EChangeLogAction REMOVE

CHANGE

public static final EChangeLogAction CHANGE

FIX

public static final EChangeLogAction FIX

UPDATE

public static final EChangeLogAction UPDATE

Method Detail

values

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

Returns:

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

valueOf

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

getID

@Nonnull
@Nonempty
public String getID()

Description copied from interface: IHasID

Get the unique ID of this object. If the type is String than the returned value must match an XML NMToken expression (so e.g. no ':' in the ID)!

Specified by:

getID in interface IHasID<String>

Returns:

The ID of this object. May not be null.

getFromIDOrNull

@Nullable
public static EChangeLogAction getFromIDOrNull(@Nullable
                                        String sID)

getFromIDOrDefault

@Nullable
public static EChangeLogAction getFromIDOrDefault(@Nullable
                                           String sID,
                                           @Nullable
                                           EChangeLogAction eDefault)