Package jmri.configurexml

Class AbstractXmlAdapter.EnumIoMapped<T extends java.lang.Enum<T>>

java.lang.Object

jmri.configurexml.AbstractXmlAdapter.EnumIO<T>

jmri.configurexml.AbstractXmlAdapter.EnumIoMapped<T>

Type Parameters:

T - generic enum class.

Enclosing class:

AbstractXmlAdapter

public static class AbstractXmlAdapter.EnumIoMapped<T extends java.lang.Enum<T>>
extends AbstractXmlAdapter.EnumIO<T>

Support for Enum I/O to XML using explicit mapping.

This converts to and from ordinal numbers so the order of definitions in the enum has to match up with the (former) constant values.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.lang.Class<T>	clazz
(package private) java.util.Map<T,java.lang.String>	mapFromEnum
(package private) java.util.Map<java.lang.String,T>	mapToEnum

Constructor Summary

Constructors

Constructor	Description
EnumIoMapped(java.lang.Class<T> clazz, java.util.Map<java.lang.String,T> mapToEnum)
EnumIoMapped(java.lang.Class<T> clazz, java.util.Map<java.lang.String,T> mapToEnum, java.util.Map<T,java.lang.String> mapFromEnum)

Method Summary

Modifier and Type	Method	Description
T	inputFromString(java.lang.String s)	Convert a String value from an XML file to an enum value.
java.lang.String	outputFromEnum(T e)	Convert an enum value to a String for storage in an XML file.

Methods inherited from class jmri.configurexml.AbstractXmlAdapter.EnumIO

inputFromAttribute

Methods inherited from class java.lang.Object

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

Field Detail

clazz

final java.lang.Class<T extends java.lang.Enum<T>> clazz

mapFromEnum

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

mapToEnum

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

Constructor Detail

EnumIoMapped

public EnumIoMapped(@Nonnull
                    java.lang.Class<T> clazz,
                    @Nonnull
                    java.util.Map<java.lang.String,T> mapToEnum,
                    @Nonnull
                    java.util.Map<T,java.lang.String> mapFromEnum)

Parameters:

clazz - enum class.

mapToEnum - Substitutes an explicit mapping for mapping from Strings to enums; this could allow e.g. accepting both name and number versions. Multiple entries are OK: this can map both "1" and "Foo" to Foo for past-schema support.

mapFromEnum - Substitutes an explicit mapping enum entries to Strings; this determines what will be written out.

EnumIoMapped

public EnumIoMapped(@Nonnull
                    java.lang.Class<T> clazz,
                    @Nonnull
                    java.util.Map<java.lang.String,T> mapToEnum)

Parameters:

clazz - enum class.

mapToEnum - Substitutes an explicit mapping for mapping from Strings to enums; this could allow e.g. accepting both name and number versions. Multiple entries are OK: this can map both "1" and "Foo" to Foo for past-schema support. The mapping from enums to Strings uses the enum names.

Method Detail

outputFromEnum

@Nonnull
public java.lang.String outputFromEnum(@Nonnull
                                       T e)

Convert an enum value to a String for storage in an XML file.

Specified by:

outputFromEnum in class AbstractXmlAdapter.EnumIO<T extends java.lang.Enum<T>>

Parameters:

e - enum value.

Returns:

storage string.

inputFromString

@Nonnull
public T inputFromString(@CheckForNull
                         java.lang.String s)

Convert a String value from an XML file to an enum value.

Specified by:

inputFromString in class AbstractXmlAdapter.EnumIO<T extends java.lang.Enum<T>>

Parameters:

s - storage string

Returns:

enum value.