de.smartics.exceptions.sample.lib.resource

Enum ResourceLoggingCode

java.lang.Object

java.lang.Enum<ResourceLoggingCode>

de.smartics.exceptions.sample.lib.resource.ResourceLoggingCode

All Implemented Interfaces:

de.smartics.exceptions.code.NumberCode, de.smartics.exceptions.core.Code, AnyServiceCode, Serializable, Comparable< ResourceLoggingCode>

public enum ResourceLoggingCode
extends Enum<ResourceLoggingCode>
implements AnyServiceCode

Defines test codes for messages with place holders.

Implementation Notes:

This set of codes is only used for logging. This way users may find additional information about what is happening in dedicated databases. If this is really worth the effort depends - as always - on your requirements. In this example we just show how logging codes look like.

Note that the enumeration implements the AnyServiceCode interface. This way, e.g. ServiceMessage provides methods that can be called with enumeration elements from different enumeration types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_RESOURCE_PREPARE Prepares to access a resource.
ACCESS_RESOURCE_SUCCESS Signals that a resource has been accessed successfully.
STORE_RESOURCE_PREPARE Prepares to store a resource.
STORE_RESOURCE_SUCCESS Signals that a resource has been stored successfully.

Field Summary

Fields

Modifier and Type	Field and Description
private de.smartics.exceptions.code.NumberCode	info The code information.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCode()
String	getComponentId()
String	getDisplayId()
Integer	getMajorNumber()
Integer	getMinorNumber()
String	toString() Returns the string representation of the object.
static ResourceLoggingCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResourceLoggingCode[]	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

STORE_RESOURCE_PREPARE

@MessageParamsDescriptor(value=ResourceMessage.class)
public static final ResourceLoggingCode STORE_RESOURCE_PREPARE

Prepares to store a resource.

STORE_RESOURCE_SUCCESS

@MessageParamsDescriptor(value=ResourceMessage.class)
public static final ResourceLoggingCode STORE_RESOURCE_SUCCESS

Signals that a resource has been stored successfully.

ACCESS_RESOURCE_PREPARE

@MessageParamsDescriptor(value=ResourceMessage.class)
public static final ResourceLoggingCode ACCESS_RESOURCE_PREPARE

Prepares to access a resource.

ACCESS_RESOURCE_SUCCESS

@MessageParamsDescriptor(value=ResourceMessage.class)
public static final ResourceLoggingCode ACCESS_RESOURCE_SUCCESS

Signals that a resource has been accessed successfully.

Field Detail

info

private final de.smartics.exceptions.code.NumberCode info

The code information.

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

Specified by:

getCode in interface de.smartics.exceptions.core.Code

getComponentId

public String getComponentId()

Specified by:

getComponentId in interface de.smartics.exceptions.core.Code

getMajorNumber

public Integer getMajorNumber()

Specified by:

getMajorNumber in interface de.smartics.exceptions.code.NumberCode

getMinorNumber

public Integer getMinorNumber()

Specified by:

getMinorNumber in interface de.smartics.exceptions.code.NumberCode

getDisplayId

public String getDisplayId()

Specified by:

getDisplayId in interface de.smartics.exceptions.core.Code

toString

public String toString()

Returns the string representation of the object.

Specified by:

toString in interface de.smartics.exceptions.core.Code

Overrides:

toString in class Enum<ResourceLoggingCode>

Returns:

the string representation of the object.