com.phloc.commons.changelog

Enum EChangeLogCategory

java.lang.Object

java.lang.Enum<EChangeLogCategory>

com.phloc.commons.changelog.EChangeLogCategory

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EChangeLogCategory>

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

Represents the category of a single change log entry.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
API
BUSINESS_LOGIC
DATA
FEATURE
PERFORMANCE
SECURITY
TECH
TEST
USER_INTERFACE

Method Summary

Methods

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

API

public static final EChangeLogCategory API

TECH

public static final EChangeLogCategory TECH

USER_INTERFACE

public static final EChangeLogCategory USER_INTERFACE

FEATURE

public static final EChangeLogCategory FEATURE

BUSINESS_LOGIC

public static final EChangeLogCategory BUSINESS_LOGIC

SECURITY

public static final EChangeLogCategory SECURITY

TEST

public static final EChangeLogCategory TEST

DATA

public static final EChangeLogCategory DATA

PERFORMANCE

public static final EChangeLogCategory PERFORMANCE

Method Detail

values

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

Returns:

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

valueOf

public static EChangeLogCategory 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 EChangeLogCategory getFromIDOrNull(@Nullable
                                          String sID)

getFromIDOrDefault

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