org.apache.tapestry5.util

Class EnumValueEncoder<E extends java.lang.Enum<E>>

java.lang.Object

org.apache.tapestry5.util.EnumValueEncoder<E>

All Implemented Interfaces:

ValueEncoder<E>

public class EnumValueEncoder<E extends java.lang.Enum<E>>
extends java.lang.Object
implements ValueEncoder<E>

A value encoder that can be used for arbitrary Enum types. The enum name is stored as the client side value.

Constructor Summary

Constructors

Constructor and Description
EnumValueEncoder(TypeCoercer typeCoercer, java.lang.Class<E> enumType)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toClient(E value) Converts a value into a client-side representation.
E	toValue(java.lang.String clientValue) Converts a client-side representation, provided by ValueEncoder.toClient(Object), back into a server-side value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumValueEncoder

public EnumValueEncoder(TypeCoercer typeCoercer,
                        java.lang.Class<E> enumType)

Method Detail

toClient

public java.lang.String toClient(E value)

Description copied from interface: ValueEncoder

Converts a value into a client-side representation. The value should be parseable by ValueEncoder.toValue(String). In some cases, what is returned is an identifier used to locate the true object, rather than a string representation of the value itself.

Specified by:

toClient in interface ValueEncoder<E extends java.lang.Enum<E>>

Parameters:

value - to be encoded

Returns:

a string representation of the value, or the value's identity

toValue

public E toValue(java.lang.String clientValue)

Description copied from interface: ValueEncoder

Converts a client-side representation, provided by ValueEncoder.toClient(Object), back into a server-side value.

Specified by:

toValue in interface ValueEncoder<E extends java.lang.Enum<E>>

Parameters:

clientValue - string representation of the value's identity

Returns:

the corresponding entity, or null if not found