Package com.thoughtworks.xstream.converters.enums

Class EnumToStringConverter<T extends java.lang.Enum<T>>

java.lang.Object

com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter

com.thoughtworks.xstream.converters.enums.EnumToStringConverter<T>

All Implemented Interfaces:

ConverterMatcher, SingleValueConverter

public class EnumToStringConverter<T extends java.lang.Enum<T>>
extends AbstractSingleValueConverter

A single value converter for a special enum type using its string representation.

Since:

1.4.5

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Class<T>	enumType
private java.util.Map<java.lang.String,T>	strings
private java.util.EnumMap<T,java.lang.String>	values

Constructor Summary

Constructors

Modifier	Constructor	Description
	EnumToStringConverter(java.lang.Class<T> type)
	EnumToStringConverter(java.lang.Class<T> type, java.util.Map<java.lang.String,T> strings)
private	EnumToStringConverter(java.lang.Class<T> type, java.util.Map<java.lang.String,T> strings, java.util.EnumMap<T,java.lang.String> values)

Method Summary

Modifier and Type	Method	Description
private static <T extends java.lang.Enum<T>> java.util.EnumMap<T,java.lang.String>	buildValueMap(java.lang.Class<T> type, java.util.Map<java.lang.String,T> strings)
boolean	canConvert(java.lang.Class type)	Determines whether the converter can marshall a particular type.
private static <T> void	checkType(java.lang.Class<T> type)
private static <T extends java.lang.Enum<T>> java.util.Map<java.lang.String,T>	extractStringMap(java.lang.Class<T> type)
java.lang.Object	fromString(java.lang.String str)	Unmarshals an Object from its single value representation.
java.lang.String	toString(java.lang.Object obj)	Marshals an Object into a single value representation.

Methods inherited from class java.lang.Object

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

Field Detail

enumType

private final java.lang.Class<T extends java.lang.Enum<T>> enumType

strings

private final java.util.Map<java.lang.String,T extends java.lang.Enum<T>> strings

values

private final java.util.EnumMap<T extends java.lang.Enum<T>,java.lang.String> values

Constructor Detail

EnumToStringConverter

public EnumToStringConverter(java.lang.Class<T> type)

EnumToStringConverter

public EnumToStringConverter(java.lang.Class<T> type,
                             java.util.Map<java.lang.String,T> strings)

EnumToStringConverter

private EnumToStringConverter(java.lang.Class<T> type,
                              java.util.Map<java.lang.String,T> strings,
                              java.util.EnumMap<T,java.lang.String> values)

Method Detail

extractStringMap

private static <T extends java.lang.Enum<T>> java.util.Map<java.lang.String,T> extractStringMap(java.lang.Class<T> type)

checkType

private static <T> void checkType(java.lang.Class<T> type)

buildValueMap

private static <T extends java.lang.Enum<T>> java.util.EnumMap<T,java.lang.String> buildValueMap(java.lang.Class<T> type,
                                                                                                       java.util.Map<java.lang.String,T> strings)

canConvert

public boolean canConvert(java.lang.Class type)

Description copied from interface: ConverterMatcher

Determines whether the converter can marshall a particular type.

Specified by:

canConvert in interface ConverterMatcher

Specified by:

canConvert in class AbstractSingleValueConverter

Parameters:

type - the Class representing the object type to be converted

toString

public java.lang.String toString(java.lang.Object obj)

Description copied from interface: SingleValueConverter

Marshals an Object into a single value representation.

Specified by:

toString in interface SingleValueConverter

Overrides:

toString in class AbstractSingleValueConverter

Parameters:

obj - the Object to be converted

Returns:

a String with the single value of the Object or null

fromString

public java.lang.Object fromString(java.lang.String str)

Description copied from interface: SingleValueConverter

Unmarshals an Object from its single value representation.

Specified by:

fromString in interface SingleValueConverter

Specified by:

fromString in class AbstractSingleValueConverter

Parameters:

str - the String with the single value of the Object

Returns:

the Object