jmri.jmrix.configurexml
Class AbstractConnectionConfigXml

Show UML class diagram

java.lang.Object
  jmri.configurexml.AbstractXmlAdapter
      jmri.jmrix.configurexml.AbstractConnectionConfigXml

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

AbstractNetworkConnectionConfigXml, AbstractSerialConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml

public abstract class AbstractConnectionConfigXml
extends AbstractXmlAdapter

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

Field Summary

(package private) static org.slf4j.Logger	log
(package private) static ResourceBundle	rb

Constructor Summary

AbstractConnectionConfigXml()

Method Summary

protected void	extendElement(org.jdom.Element e) Customizable method if you need to add anything more
protected abstract void	getInstance()
abstract boolean	load(org.jdom.Element e) Update static data from XML file
void	load(org.jdom.Element element, Object o) Update static data from XML file
protected void	loadCommon(org.jdom.Element e, PortAdapter adapter)
protected void	loadOptions(org.jdom.Element e, PortAdapter adapter)
protected abstract void	register()
protected void	saveOptions(org.jdom.Element e, PortAdapter adapter)
abstract org.jdom.Element	store(Object o) Default implementation for storing the static contents of the serial port implementation
protected void	storeCommon(org.jdom.Element e, PortAdapter adapter)
protected void	unpackElement(org.jdom.Element e) Customizable method if you need to add anything more

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

creationErrorEncountered, getConfigXmlManager, loadDeferred, loadOrder, setConfigXmlManager

Methods inherited from class java.lang.Object

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

Field Detail

rb

static ResourceBundle rb

log

static org.slf4j.Logger log

Constructor Detail

AbstractConnectionConfigXml

public AbstractConnectionConfigXml()

Method Detail

getInstance

protected abstract void getInstance()

register

protected abstract void register()

store

public abstract org.jdom.Element store(Object o)

Default implementation for storing the static contents of the serial port implementation

Parameters:

o - Object to store, of type PositionableLabel

Returns:

Element containing the complete info

storeCommon

protected void storeCommon(org.jdom.Element e,
                           PortAdapter adapter)

extendElement

protected void extendElement(org.jdom.Element e)

Customizable method if you need to add anything more

Parameters:

e - Element being created, update as needed

load

public abstract boolean load(org.jdom.Element e)
                      throws Exception

Update static data from XML file

Parameters:

e - Top level Element to unpack.

Returns:

true if successful

Throws:

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

loadCommon

protected void loadCommon(org.jdom.Element e,
                          PortAdapter adapter)

saveOptions

protected void saveOptions(org.jdom.Element e,
                           PortAdapter adapter)

loadOptions

protected void loadOptions(org.jdom.Element e,
                           PortAdapter adapter)

unpackElement

protected void unpackElement(org.jdom.Element e)

Customizable method if you need to add anything more

Parameters:

e - Element being created, update as needed

load

public void load(org.jdom.Element element,
                 Object o)

Update static data from XML file

Parameters:

element - Top level Element to unpack.

o - Implementation-specific Object needed for the conversion