org.springframework.data.rest.webmvc.json

Class EnumTranslator

java.lang.Object

org.springframework.data.rest.webmvc.json.EnumTranslator

All Implemented Interfaces:

EnumTranslationConfiguration

public class EnumTranslator
extends Object
implements EnumTranslationConfiguration

Configuration to tweak enum serialization.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
EnumTranslator(MessageSourceAccessor messageSourceAccessor) Creates a new EnumTranslator using the given MessageSourceAccessor.

Method Summary

Modifier and Type	Method and Description
String	asText(Enum<?> value) Resolves the given enum value into a String consulting the configured MessageSourceAccessor potentially falling back to the default translation if configured.
<T extends Enum<?>> T	fromText(Class<T> type, String text) Parses the given source text into the corresponding enum value using the configured MessageSourceAccessor potentially falling back to the default translation or the plain enum name if configured.
List<String>	getValues(Class<? extends Enum<?>> type) Returns all potentially translated values for the given Enum type.
void	setEnableDefaultTranslation(boolean enableDefaultTranslation)
void	setParseEnumNameAsFallback(boolean parseEnumNameAsFallback)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumTranslator

public EnumTranslator(MessageSourceAccessor messageSourceAccessor)

Creates a new EnumTranslator using the given MessageSourceAccessor.

Parameters:

messageSourceAccessor - must not be null.

Method Detail

setEnableDefaultTranslation

public void setEnableDefaultTranslation(boolean enableDefaultTranslation)

Specified by:

setEnableDefaultTranslation in interface EnumTranslationConfiguration

setParseEnumNameAsFallback

public void setParseEnumNameAsFallback(boolean parseEnumNameAsFallback)

Specified by:

setParseEnumNameAsFallback in interface EnumTranslationConfiguration

asText

public String asText(Enum<?> value)

Resolves the given enum value into a String consulting the configured MessageSourceAccessor potentially falling back to the default translation if configured. Returning the plain enum name if no resolution applies.

Parameters:

value - must not be null.

Returns:

getValues

public List<String> getValues(Class<? extends Enum<?>> type)

Returns all potentially translated values for the given Enum type.

Parameters:

type - must not be null.

Returns:

fromText

public <T extends Enum<?>> T fromText(Class<T> type,
                                      String text)

Parses the given source text into the corresponding enum value using the configured MessageSourceAccessor potentially falling back to the default translation or the plain enum name if configured.

Parameters:

type - must not be null.

text - can be null

Returns:

the resolved enum or null if the resolution failed.