de.xima.fc.converter.simple

Class EnumTransform<T extends Enum<T>>

java.lang.Object

de.xima.fc.converter.simple.EnumTransform<T>

Type Parameters:

T - Type of the enum class.

All Implemented Interfaces:

org.simpleframework.xml.transform.Transform<T>

public class EnumTransform<T extends Enum<T>>
extends Object
implements org.simpleframework.xml.transform.Transform<T>

Transformer similar to for enums which allows you to specify how unknown enum constants are handled.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor and Description
EnumTransform(Class<T> enumClass) An enum transformer that uses the strategyThrow() strategy.
EnumTransform(Class<T> enumClass, BiFunction<Class<T>,String,T> unknownEnumStrategy) An enum transformer that uses the specified strategy for handling unknown enums.

Method Summary

Modifier and Type	Method and Description
T	read(String value)
static <T extends Enum<T>> BiFunction<Class<T>,String,T>	strategyNull()
static <T extends Enum<T>> BiFunction<Class<T>,String,T>	strategyThrow()
String	write(T value)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumTransform

public EnumTransform(Class<T> enumClass)

An enum transformer that uses the strategyThrow() strategy.

Parameters:

enumClass - Class of the enum type.

EnumTransform

public EnumTransform(Class<T> enumClass,
                     BiFunction<Class<T>,String,T> unknownEnumStrategy)

An enum transformer that uses the specified strategy for handling unknown enums.

Parameters:

enumClass - Class of the enum type.

unknownEnumStrategy - Strategy for resolving unknown enums. It is passed the enum class and the serialized string.

Method Detail

read

public T read(String value)
       throws Exception

Specified by:

read in interface org.simpleframework.xml.transform.Transform<T extends Enum<T>>

Throws:

Exception

write

public String write(T value)
             throws Exception

Specified by:

write in interface org.simpleframework.xml.transform.Transform<T extends Enum<T>>

Throws:

Exception

strategyNull

public static <T extends Enum<T>> BiFunction<Class<T>,String,T> strategyNull()

Returns:

A strategy that, if the enum constant does not exist, substitutes null.

strategyThrow

public static <T extends Enum<T>> BiFunction<Class<T>,String,T> strategyThrow()

Returns:

A strategy that, if the enum constant does not exist, throws an IllegalArgumentException.