Package jmri.managers.configurexml
Class AbstractReporterManagerConfigXML
- java.lang.Object
-
- jmri.configurexml.AbstractXmlAdapter
-
- jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML
-
- jmri.managers.configurexml.AbstractReporterManagerConfigXML
-
- All Implemented Interfaces:
XmlAdapter
- Direct Known Subclasses:
BiDiBReporterManagerXml
,CbusReporterManagerXml
,Dcc4PcReporterManagerXml
,EcosReporterManagerXml
,InternalReporterManagerXml
,JMRIClientReporterManagerXml
,LnReporterManagerXml
,MqttReporterManagerXml
,OlcbReporterManagerXml
,RfidReporterManagerXml
,RpsReporterManagerXml
,Z21ReporterManagerXml
public abstract class AbstractReporterManagerConfigXML extends AbstractNamedBeanManagerConfigXML
Provides the abstract base and store functionality for configuring ReporterManagers, working with AbstractReporterManagers.Typically, a subclass will just implement the load(Element Reporters) class, relying on implementation here to load the individual Reporters. Note that these are stored explicitly, so the resolution mechanism doesn't need to see *Xml classes for each specific Reporter or AbstractReporter subclass at store time.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class jmri.configurexml.AbstractXmlAdapter
AbstractXmlAdapter.EnumIO<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoMapped<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoNames<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoNamesNumbers<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoOrdinals<T extends java.lang.Enum<T>>
-
-
Constructor Summary
Constructors Constructor Description AbstractReporterManagerConfigXML()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
loadOrder()
boolean
loadReporters(org.jdom2.Element reporters)
Utility method to load the individual Reporter objects.abstract void
setStoreElementClass(org.jdom2.Element reporters)
Subclass provides implementation to create the correct top element, including the type information.org.jdom2.Element
store(java.lang.Object o)
Default implementation for storing the contents of a ReporterManager-
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
-
-
-
-
Constructor Detail
-
AbstractReporterManagerConfigXML
public AbstractReporterManagerConfigXML()
-
-
Method Detail
-
store
public org.jdom2.Element store(java.lang.Object o)
Default implementation for storing the contents of a ReporterManager- Parameters:
o
- Object to store, of type ReporterManager- Returns:
- Element containing the complete info
-
setStoreElementClass
public abstract void setStoreElementClass(org.jdom2.Element reporters)
Subclass provides implementation to create the correct top element, including the type information. Default implementation is to use the local class here.- Parameters:
reporters
- The top-level element being created
-
loadReporters
public boolean loadReporters(org.jdom2.Element reporters)
Utility method to load the individual Reporter objects. If there's no additional info needed for a specific Reporter type, invoke this with the parent of the set of Reporter elements.- Parameters:
reporters
- Element containing the Reporter elements to load.- Returns:
- true if successful
-
loadOrder
public int loadOrder()
Description copied from class:AbstractXmlAdapter
- Specified by:
loadOrder
in interfaceXmlAdapter
- Overrides:
loadOrder
in classAbstractXmlAdapter
-
-