de.vandermeer.skb.base.message

Enum EMessageType

java.lang.Object

java.lang.Enum<EMessageType>

de.vandermeer.skb.base.message.EMessageType

All Implemented Interfaces:

Serializable, Comparable<EMessageType>

public enum EMessageType
extends Enum<EMessageType>

Types for Message5WH. Supported types are information, warning and error. Each type has an associated unique number and a default name for a logger. The logger name can be used in combination with logging frameworks (such as slf4j or log4j), which need to be configured appropriatetly.

Version:

v0.0.3 build 150618 (18-Jun-15) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR An error message, usually rather formal in format
INFO An information (or informal) message
WARNING A warning message, usually rather formal in format

Method Summary

Modifier and Type	Method and Description
String	getLoggerName() Returns the logger name associated with the enumerate instance.
int	getNumber() Returns a unique number for this enumerate.
String	toString()
static EMessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EMessageType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INFO

public static final EMessageType INFO

An information (or informal) message

WARNING

public static final EMessageType WARNING

A warning message, usually rather formal in format

ERROR

public static final EMessageType ERROR

An error message, usually rather formal in format

Method Detail

values

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

Returns:

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

valueOf

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

getLoggerName

public String getLoggerName()

Returns the logger name associated with the enumerate instance. The logger name is a string, uses "SKBLogger" as prefix and then a capitalised version of the enumerate's name as a suffix. This makes the returned name unique. In association with logging frameworks, such as log4j or slf4j, it can be used to automatically retrieve a logger for a message of this type.

Returns:

logger name

getNumber

public int getNumber()

Returns a unique number for this enumerate.

Returns:

unique number between 0 and numbers of enumerates in the class

toString

public String toString()

Overrides:

toString in class Enum<EMessageType>