Package jmri.managers.configurexml

Class AbstractStringIOManagerConfigXML

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

jmri.managers.configurexml.AbstractStringIOManagerConfigXML

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

InternalStringIOManagerXml, OlcbStringIOManagerXml

public abstract class AbstractStringIOManagerConfigXML
extends AbstractNamedBeanManagerConfigXML

Provides the abstract base and store functionality for configuring StringIOManagers, working with AbstractStringIOManagers.

Typically, a subclass will just implement the load(Element StringIOs) class, relying on implementation here to load the individual StringIOs. Note that these are stored explicitly, so the resolution mechanism doesn't need to see *Xml classes for each specific StringIO or AbstractStringIO subclass at store time.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.configurexml.AbstractXmlAdapter

AbstractXmlAdapter.EnumIO<T extends Enum<T>>, AbstractXmlAdapter.EnumIoMapped<T extends Enum<T>>, AbstractXmlAdapter.EnumIoNames<T extends Enum<T>>, AbstractXmlAdapter.EnumIoNamesNumbers<T extends Enum<T>>, AbstractXmlAdapter.EnumIoOrdinals<T extends Enum<T>>

Field Summary

Fields inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

STR_CLASS, STR_COMMENT, STR_KEY, STR_PROPERTIES, STR_PROPERTY, STR_SYSTEM_NAME, STR_USER_NAME, STR_VALUE

Fields inherited from class jmri.configurexml.AbstractXmlAdapter

STR_FALSE, STR_NO, STR_TRUE, STR_YES

Constructor Summary

Constructors

Constructor	Description
AbstractStringIOManagerConfigXML()

Method Summary

Modifier and Type	Method	Description
int	loadOrder()
boolean	loadStringIOs(org.jdom2.Element stringIOs)	Utility method to load the individual StringIO objects.
abstract void	setStoreElementClass(org.jdom2.Element stringIOs)	Subclass provides an implementation to create the correct top element, including the type information.
org.jdom2.Element	store(Object o)	Default implementation for storing the contents of a StringIOManager

Methods inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

checkedNamedBeanHandle, checkedNamedBeanName, checkedNamedBeanReference, checkNameNormalization, getAttributeBool, getAttributeString, getSystemName, getUserName, getUserName, loadComment, loadComment, loadCommon, loadInAdapter, loadProperties, storeComment, storeCommon, storeProperties, storeUserName

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

getAttributeBooleanValue, getAttributeDoubleValue, getAttributeFloatValue, getAttributeIntegerValue, getExceptionHandler, handleException, load, load, load, load, loadDeferred, setExceptionHandler, store

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractStringIOManagerConfigXML

public AbstractStringIOManagerConfigXML()

Method Details

store

public org.jdom2.Element store(Object o)

Default implementation for storing the contents of a StringIOManager

Parameters:

o - Object to store, of type StringIOManager

Returns:

Element containing the complete info

setStoreElementClass

public abstract void setStoreElementClass(org.jdom2.Element stringIOs)

Subclass provides an implementation to create the correct top element, including the type information. Default implementation is to use the local class here.

Parameters:

stringIOs - The top-level element being created

loadStringIOs

public boolean loadStringIOs(org.jdom2.Element stringIOs)

Utility method to load the individual StringIO objects. If there's no additional info needed for a specific StringIO type, invoke this with the parent of the set of StringIO elements.

Parameters:

stringIOs - Element containing the StringIO elements to load.

Returns:

true if successful

loadOrder

public int loadOrder()

Description copied from class: AbstractXmlAdapter

Specified by:

loadOrder in interface XmlAdapter

Overrides:

loadOrder in class AbstractXmlAdapter