public class EnumTranslator extends Object implements EnumTranslationConfiguration
Constructor and Description |
---|
EnumTranslator(org.springframework.hateoas.mediatype.MessageResolver resolver)
Creates a new
EnumTranslator using the given MessageSourceAccessor . |
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<?>> |
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)
Configures whether the default translation of enum names shall be applied.
|
void |
setParseEnumNameAsFallback(boolean parseEnumNameAsFallback)
Configures whether to always accept the raw enum name when parsing.
|
public EnumTranslator(org.springframework.hateoas.mediatype.MessageResolver resolver)
EnumTranslator
using the given MessageSourceAccessor
.resolver
- must not be null.public void setEnableDefaultTranslation(boolean enableDefaultTranslation)
EnumTranslationConfiguration
String
s and also parse them if - only if - no
explicit translation is available.setEnableDefaultTranslation
in interface EnumTranslationConfiguration
enableDefaultTranslation
- whether to enable the default translation of enum names.public void setParseEnumNameAsFallback(boolean parseEnumNameAsFallback)
EnumTranslationConfiguration
setParseEnumNameAsFallback
in interface EnumTranslationConfiguration
parseEnumNameAsFallback
- whether to parse the raw enum value as fallback, even if an explicit translation is
available.public String asText(Enum<?> value)
String
consulting the configured MessageSourceAccessor
potentially falling back to the default translation if configured. Returning the plain enum name if no resolution
applies.value
- must not be null.public List<String> getValues(Class<? extends Enum<?>> type)
Enum
type.type
- must not be null.public <T extends Enum<?>> T fromText(Class<T> type, String text)
MessageSourceAccessor
potentially falling back to the default translation or the plain enum name if configured.type
- must not be null.text
- can be nullCopyright © 2011–2022 Pivotal Software, Inc.. All rights reserved.