com.lexmark.saperion.util

Class ConstantUtils

java.lang.Object

com.lexmark.saperion.util.ConstantUtils

public final class ConstantUtils
extends Object

Utility class to deal with constant definitions. This class allows to analyze constant definitions, to list the defined constant values, to retrieve a constant's name, and to validate the constant definition class. Constant definitions are a collection of named constants. Valid constant values MUST be defined as public, static, and final. They can be of arbitrary type, but MUST implement an appropriate Object.equals(Object) method. Constant type implementations SHOULD provide adequate protection mechanisms to prevent changes of the constant values.

Author:

owaeldrich

Method Summary

Modifier and Type	Method and Description
static <T> Map<String,T>	duplicates(Class<?> constantDefinition, Class<T> constantType) Inspects a constant definition class and returns all duplicate constant definitions of the given element type.
static String	name(Class<?> constantDefinition, Object constant) Inspects a constant definition class and returns the constant's name.
static <T> T[]	values(Class<?> constantDefinition, Class<T> constantType) Inspects a constant definition class and returns all constant definitions of the given element type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

duplicates

public static <T> Map<String,T> duplicates(Class<?> constantDefinition,
                                           Class<T> constantType)

Inspects a constant definition class and returns all duplicate constant definitions of the given element type. A constant definition is acknowledged as duplicate if another constant definition with an equal value exists. In order to check equality the Object.equals(Object) method of the constant value is called.

Type Parameters:

T - the constant element type

Parameters:

constantDefinition - the constant definition class

constantType - the constant element type

Returns:

the declared constant values of the given element type from the constant declaration

name

public static String name(Class<?> constantDefinition,
                          Object constant)

Inspects a constant definition class and returns the constant's name.

Parameters:

constantDefinition - the constant definition class

constant - the constant element type

Returns:

the name of the declared constant, or null if no equal constant was found in the definition

values

public static <T> T[] values(Class<?> constantDefinition,
                             Class<T> constantType)

Inspects a constant definition class and returns all constant definitions of the given element type.

Type Parameters:

T - the constant element type

Parameters:

constantDefinition - the constant definition class

constantType - the constant element type

Returns:

the declared constant values of the given element type from the constant declaration