Package jmri.jmrix.mqtt.configurexml

Class MqttReporterManagerXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

jmri.managers.configurexml.AbstractReporterManagerConfigXML

jmri.jmrix.mqtt.configurexml.MqttReporterManagerXml

All Implemented Interfaces:

XmlAdapter

public class MqttReporterManagerXml
extends AbstractReporterManagerConfigXML

Provides load and store functionality for configuring MqttReporterManagers.

Uses the store method from the abstract base class, but provides a load method here.

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
MqttReporterManagerXml()

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 sensors)	Subclass provides implementation to create the correct top element, including the type information.

Methods inherited from class jmri.managers.configurexml.AbstractReporterManagerConfigXML

loadOrder, loadReporters, store

Methods inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

checkedNamedBeanHandle, checkedNamedBeanName, checkedNamedBeanReference, getSystemName, getUserName, getUserName, loadCommon, storeCommon

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

getAttributeBooleanValue, getAttributeDoubleValue, getAttributeFloatValue, getAttributeIntegerValue, getExceptionHandler, handleException, 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

MqttReporterManagerXml

public MqttReporterManagerXml()

Method Details

setStoreElementClass

public void setStoreElementClass(org.jdom2.Element sensors)

Description copied from class: AbstractReporterManagerConfigXML

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

Specified by:

setStoreElementClass in class AbstractReporterManagerConfigXML

Parameters:

sensors - The top-level element being created

load

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

Description copied from class: AbstractXmlAdapter

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