Package jmri.jmrix.configurexml

Class AbstractNetworkConnectionConfigXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.jmrix.configurexml.AbstractConnectionConfigXml

jmri.jmrix.configurexml.AbstractNetworkConnectionConfigXml

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, MarklinSimConnectionConfigXml, MqttConnectionConfigXml

public abstract class AbstractNetworkConnectionConfigXml
extends AbstractConnectionConfigXml

Abstract base (and partial implementation) for classes persisting the status of Network port adapters.

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>>

Field Summary

Fields

Modifier and Type	Field	Description
protected NetworkPortAdapter	adapter

Constructor Summary

Constructors

Constructor	Description
AbstractNetworkConnectionConfigXml()

Method Summary

Modifier and Type	Method	Description
protected void	dispose()
protected void	extendElement(org.jdom2.Element e)	Customizable method if you need to add anything more.
protected void	getInstance(java.lang.Object object)
void	load(org.jdom2.Element element, java.lang.Object o)	Update static data from XML file.
boolean	load(org.jdom2.Element shared, org.jdom2.Element perNode)	Create a set of configured objects from their XML description.
org.jdom2.Element	store(java.lang.Object o)	Default implementation for storing the static contents of the Network port implementation.

Methods inherited from class jmri.jmrix.configurexml.AbstractConnectionConfigXml

findParmValue, getInstance, loadCommon, loadOptions, register, register, saveOptions, setOutputInterval, store, storeCommon, unpackElement

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

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

Methods inherited from class java.lang.Object

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

Field Detail

adapter

protected NetworkPortAdapter adapter

Constructor Detail

AbstractNetworkConnectionConfigXml

public AbstractNetworkConnectionConfigXml()

Method Detail

getInstance

protected void getInstance(java.lang.Object object)

store

public org.jdom2.Element store(java.lang.Object o)

Default implementation for storing the static contents of the Network port implementation.

Parameters:

o - Object to store, of type PositionableLabel

Returns:

Element containing the complete info

extendElement

protected void extendElement(org.jdom2.Element e)

Customizable method if you need to add anything more.

Overrides:

extendElement in class AbstractConnectionConfigXml

Parameters:

e - Element being created, update as needed

load

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

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

load

public void load(org.jdom2.Element element,
                 java.lang.Object o)

Update static data from XML file.

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

element - Top level Element to unpack.

o - Implementation-specific Object needed for the conversion

dispose

protected void dispose()

Specified by:

dispose in class AbstractConnectionConfigXml