alma.acs.logging.level

Enum AcsLogLevelDefinition

java.lang.Object

java.lang.Enum<AcsLogLevelDefinition>

alma.acs.logging.level.AcsLogLevelDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AcsLogLevelDefinition>

public enum AcsLogLevelDefinition
extends java.lang.Enum<AcsLogLevelDefinition>

An enum with the log levels, defined in the IDL. It is a convenience class encapsulating the IDL constants of the log levels.

Each item of the enumerated is composed of a name and a value, both read directly from the IDL definition LogLevels:
-name comes from _NAME
-value comes from _VAL.

There are also a number of methods to convert to/from/between the log level definitions in IDL, XSD, and this enum.

Author:

acaproni

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALERT
CRITICAL
DEBUG
DELOUSE
EMERGENCY
ERROR
INFO
NOTICE
OFF
TRACE
WARNING

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name The name of the log (the string read from the IDL)
int	value The value of the log (the integer read from the IDL)

Method Summary

Modifier and Type	Method and Description
static alma.Logging.LoggingConfigurablePackage.LogLevels	createIdlLogLevelsFromXsd(boolean useDefault, UnnamedLogger xsdLevels) Convenience method that creates the IDL-defined log level struct from the XSD-defined levels and the default flag.
static UnnamedLogger	createXsdLogLevelsFromIdl(alma.Logging.LoggingConfigurablePackage.LogLevels idlLevels)
static AcsLogLevelDefinition	fromInteger(int val) Return a log level given its integer value.
static AcsLogLevelDefinition	fromName(java.lang.String name) Return a log level, given its name.
static AcsLogLevelDefinition	fromXsdLogLevel(LogLevel legalLogLevel) Helper method that converts an xsd defined log level to the matching enum literal.
AcsLogLevelDefinition	getNextHigherLevel() Use this method only for testing! Returns the next log level in the list of enum literals, or null if there is no next level or the next level would be OFF.
boolean	isEqualXsdLevel(LogLevel schemaLevel) Checks if an xsd-defined log level is equal to this IDL-defined level by comparing the underlying integer values.
LogLevel	toXsdLevel() Returns the LogLevel defined in maciidl/ws/config/CDB/schemas/LoggingConfig.xsd whose integer value matches this enum's value.
static AcsLogLevelDefinition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AcsLogLevelDefinition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static LogLevel	xsdLevelFromInteger(int level)

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

TRACE

public static final AcsLogLevelDefinition TRACE

DELOUSE

public static final AcsLogLevelDefinition DELOUSE

DEBUG

public static final AcsLogLevelDefinition DEBUG

INFO

public static final AcsLogLevelDefinition INFO

NOTICE

public static final AcsLogLevelDefinition NOTICE

WARNING

public static final AcsLogLevelDefinition WARNING

ERROR

public static final AcsLogLevelDefinition ERROR

CRITICAL

public static final AcsLogLevelDefinition CRITICAL

ALERT

public static final AcsLogLevelDefinition ALERT

EMERGENCY

public static final AcsLogLevelDefinition EMERGENCY

OFF

public static final AcsLogLevelDefinition OFF

Field Detail

value

public final int value

The value of the log (the integer read from the IDL)

name

public final java.lang.String name

The name of the log (the string read from the IDL)

Method Detail

values

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

Returns:

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

valueOf

public static AcsLogLevelDefinition valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromName

public static AcsLogLevelDefinition fromName(java.lang.String name)
                                      throws AcsJIllegalArgumentEx

Return a log level, given its name.

This method is similar to valueOf(String) except that it throws an Acs exception instead of a RuntimeException.

Parameters:

name - The (not null, not empty) name of the log level

Returns:

The log level having the name as its name

Throws:

AcsJIllegalArgumentEx - if name is null or not a valid IDL-defined log level name.

getNextHigherLevel

public AcsLogLevelDefinition getNextHigherLevel()

Use this method only for testing! Returns the next log level in the list of enum literals, or null if there is no next level or the next level would be OFF.

fromInteger

public static AcsLogLevelDefinition fromInteger(int val)
                                         throws AcsJIllegalArgumentEx

Return a log level given its integer value.

Parameters:

val - The value of the log level

Returns:

The log level having val as its value

Throws:

AcsJIllegalArgumentEx - if val did not match any AcsLogLevelDefinition.

fromXsdLogLevel

public static AcsLogLevelDefinition fromXsdLogLevel(LogLevel legalLogLevel)
                                             throws AcsJIllegalArgumentEx

Helper method that converts an xsd defined log level to the matching enum literal.

Throws:

AcsJIllegalArgumentEx

toXsdLevel

public LogLevel toXsdLevel()

Returns the LogLevel defined in maciidl/ws/config/CDB/schemas/LoggingConfig.xsd whose integer value matches this enum's value.

Throws:

java.lang.IllegalArgumentException - if no matching Xsd-defined level can be found (should never happen as long as IDL and XSD files are aligned)

xsdLevelFromInteger

public static LogLevel xsdLevelFromInteger(int level)
                                    throws AcsJIllegalArgumentEx

Throws:

AcsJIllegalArgumentEx

isEqualXsdLevel

public boolean isEqualXsdLevel(LogLevel schemaLevel)

Checks if an xsd-defined log level is equal to this IDL-defined level by comparing the underlying integer values.

Throws:

java.lang.IllegalArgumentException - if schemaLevel is null.

createIdlLogLevelsFromXsd

public static alma.Logging.LoggingConfigurablePackage.LogLevels createIdlLogLevelsFromXsd(boolean useDefault,
                                                                                          UnnamedLogger xsdLevels)

Convenience method that creates the IDL-defined log level struct from the XSD-defined levels and the default flag.

createXsdLogLevelsFromIdl

public static UnnamedLogger createXsdLogLevelsFromIdl(alma.Logging.LoggingConfigurablePackage.LogLevels idlLevels)
                                               throws AcsJIllegalArgumentEx

Throws:

AcsJIllegalArgumentEx