com.helger.photon.basic.app.systemmsg

Enum ESystemMessageType

java.lang.Object

java.lang.Enum<ESystemMessageType>

com.helger.photon.basic.app.systemmsg.ESystemMessageType

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.text.display.IHasDisplayText, Serializable, Comparable<ESystemMessageType>

public enum ESystemMessageType
extends Enum<ESystemMessageType>
implements com.helger.commons.id.IHasID<String>, com.helger.commons.text.display.IHasDisplayText

This enumeration defines the different system message types.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR
INFO
SUCCESS
WARNING

Field Summary

Fields

Modifier and Type	Field and Description
static ESystemMessageType	DEFAULT

Method Summary

Modifier and Type	Method and Description
String	getDisplayText(Locale aContentLocale)
static ESystemMessageType	getFromIDOrDefault(String sID)
String	getID()
static ESystemMessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ESystemMessageType[]	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

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getAsHasText, getComparatorCollating

Enum Constant Detail

INFO

public static final ESystemMessageType INFO

WARNING

public static final ESystemMessageType WARNING

ERROR

public static final ESystemMessageType ERROR

SUCCESS

public static final ESystemMessageType SUCCESS

Field Detail

DEFAULT

public static final ESystemMessageType DEFAULT

Method Detail

values

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

Returns:

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

valueOf

public static ESystemMessageType 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()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                                        Locale aContentLocale)

Specified by:

getDisplayText in interface com.helger.commons.text.display.IHasDisplayText

getFromIDOrDefault

@Nonnull
public static ESystemMessageType getFromIDOrDefault(@Nullable
                                                              String sID)