org.josef.util

Class EnumMapper<F extends Enum<F>,S extends Enum<S>>

java.lang.Object

org.josef.util.EnumMapper<F,S>

Type Parameters:

F - Type of the first enumeration.

S - Type of the second enumeration.

@ThreadSafety(level=NOT_THREAD_SAFE,
              doc="Please initialize your maps with a static initializer")
public final class EnumMapper<F extends Enum<F>,S extends Enum<S>>
extends Object

Utility class to map the enumerated constants of one enumeration, to the enumerated constants of another enumeration and vice versa.

Version:

$Revision: 5772 $

Author:

rens.van.leeuwen@leanapps.com

Constructor Summary

Constructors

Constructor and Description
EnumMapper(Class<F> firstEnumClass, Class<S> secondEnumClass) Constructs this EnumMapper from the supplied firstEnumClass and secondEnumClass.

Method Summary

Modifier and Type	Method and Description
void	map(F firstEnumeratedConstant, S secondEnumeratedConstant) Maps the supplied firstEnumeratedConstant to the supplied secondEnumeratedConstant and the other way around.
F	toFirstType(S secondEnumeratedConstant) Gets the enumerated constant of the first type, that is mapped to the supplied secondEnumeratedConstant of the second type.
S	toSecondType(F firstEnumeratedConstant) Gets the enumerated constant of the second type, that is mapped to the supplied firstEnumeratedConstant of the first type.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumMapper

public EnumMapper(Class<F> firstEnumClass,
                  Class<S> secondEnumClass)

Constructs this EnumMapper from the supplied firstEnumClass and secondEnumClass.
After creation the maps will be empty.

Parameters:

firstEnumClass - The class type of the first enumeration.

secondEnumClass - The class type of the second enumeration.

Throws:

NullPointerException - When either the supplied firstEnumClass or the supplied secondEnumClass is null.

Method Detail

map

public void map(F firstEnumeratedConstant,
                S secondEnumeratedConstant)

Maps the supplied firstEnumeratedConstant to the supplied secondEnumeratedConstant and the other way around.

Parameters:

firstEnumeratedConstant - The first enumerated constant.

secondEnumeratedConstant - The second enumerated constant.

Throws:

NullPointerException - When either the supplied firstEnumeratedConstant or the supplied secondEnumeratedConstant is null.

toSecondType

public S toSecondType(F firstEnumeratedConstant)

Gets the enumerated constant of the second type, that is mapped to the supplied firstEnumeratedConstant of the first type.

Parameters:

firstEnumeratedConstant - The enumerated constant of the first type.

Returns:

The enumerated constant of the second type, that is mapped to the supplied firstEnumeratedConstant of the first type.

Throws:

IllegalArgumentException - When the supplied firstEnumeratedConstant has not been mapped to an enumerated constant of the second type.

NullPointerException - when the supplied firstEnumeratedConstant is null.

toFirstType

public F toFirstType(S secondEnumeratedConstant)

Gets the enumerated constant of the first type, that is mapped to the supplied secondEnumeratedConstant of the second type.

Parameters:

secondEnumeratedConstant - The enumerated constant of the second type.

Returns:

The enumerated constant of the first type, that is mapped to the supplied secondEnumeratedConstant of the second type.

Throws:

IllegalArgumentException - When the supplied secondEnumeratedConstant has not been mapped to an enumerated constant of the first type.

NullPointerException - when the supplied secondEnumeratedConstant is null.