Package jmri.jmrit.swing.meter.configurexml

Class MeterFrameManagerXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.jmrit.swing.meter.configurexml.MeterFrameManagerXml

All Implemented Interfaces:

XmlAdapter

public class MeterFrameManagerXml
extends AbstractXmlAdapter

Stores MeterFrames to the panel file.

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.configurexml.AbstractXmlAdapter

STR_FALSE, STR_NO, STR_TRUE, STR_YES

Constructor Summary

Constructors

Constructor	Description
MeterFrameManagerXml()

Method Summary

Modifier and Type	Method	Description
boolean	load(org.jdom2.Element shared, org.jdom2.Element perNode)	Create a set of configured objects from their XML description.
void	setStoreElementClass(org.jdom2.Element meterFrames)	Subclass provides implementation to create the correct top element, including the type information.
org.jdom2.Element	store(Object o)	Store the object in XML
org.jdom2.Element	storeMeterFrame(MeterFrame frame)

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

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

Methods inherited from class java.lang.Object

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

Constructor Details

MeterFrameManagerXml

public MeterFrameManagerXml()

Method Details

store

public org.jdom2.Element store(Object o)

Description copied from interface: XmlAdapter

Store the object in XML

Parameters:

o - The object to be recorded. Specific XmlAdapter implementations will require this to be of a specific type; that binding is done in ConfigXmlManager.

Returns:

The XML representation Element

storeMeterFrame

public org.jdom2.Element storeMeterFrame(MeterFrame frame)

setStoreElementClass

public void setStoreElementClass(org.jdom2.Element meterFrames)

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

Parameters:

meterFrames - The top-level element being created

load

public boolean load(@Nonnull
 org.jdom2.Element shared,
 org.jdom2.Element perNode)
             throws JmriConfigureXmlException

Create a set of configured objects from their XML description.

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

shared - Top-level XML element containing the common, multi-node elements of the description

perNode - Top-level XML element containing the private, single-node elements of the description

Returns:

true if successful

Throws:

JmriConfigureXmlException - when a error prevents creating the objects as as required by the input XML