Package jmri.jmrit.revhistory.configurexml

Class FileHistoryXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.jmrit.revhistory.configurexml.FileHistoryXml

All Implemented Interfaces:

XmlAdapter

public class FileHistoryXml
extends AbstractXmlAdapter

Load/Store FileHistory objects.

This interacts somewhat differently with the ConfigureXML system. FileHistory objects are _not_ registed with the manager, but rather handled explicitly by them. The "load()" method is therefore a null-op here.

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
(package private) static int	defaultDepth

Fields inherited from class jmri.configurexml.AbstractXmlAdapter

STR_FALSE, STR_NO, STR_TRUE, STR_YES

Constructor Summary

Constructors

Constructor	Description
FileHistoryXml()

Method Summary

Modifier and Type	Method	Description
(package private) static org.jdom2.Element	historyElement(FileHistory r, int depth)
void	load(org.jdom2.Element e, java.lang.Object o)	Create a set of configured objects from their XML description, using an auxiliary object.
boolean	load(org.jdom2.Element shared, org.jdom2.Element perNode)	Usual configurexml method, this one doesn't do anything because the content is explicitly loaded from the file
boolean	loadDirectly(org.jdom2.Element e)	Load RevHistory from an element.
static FileHistory	loadFileHistory(org.jdom2.Element e)
static void	loadOperation(FileHistory r, org.jdom2.Element e)
(package private) static org.jdom2.Element	operationElement(FileHistory.OperationMemo r, int depth)
org.jdom2.Element	store(java.lang.Object o)	Store the
static org.jdom2.Element	storeDirectly(java.lang.Object o, java.lang.String fileName)

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

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

Methods inherited from class java.lang.Object

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

Field Detail

defaultDepth

static int defaultDepth

Constructor Detail

FileHistoryXml

public FileHistoryXml()

Method Detail

load

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

Usual configurexml method, this one doesn't do anything because the content is explicitly loaded from the file

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

loadDirectly

public boolean loadDirectly(org.jdom2.Element e)

Load RevHistory from an element.

If no RevHistory already present in InstanceManager, creates one and adds this.

Then adds, instead of replacing, the history information

Parameters:

e - element to load.

Returns:

true when complete, false if unexpected.

loadFileHistory

public static FileHistory loadFileHistory(org.jdom2.Element e)

loadOperation

public static void loadOperation(FileHistory r,
                                 org.jdom2.Element e)

load

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

Create a set of configured objects from their XML description, using an auxiliary object.

For example, the auxilary object o might be a manager or GUI of some type that needs to be informed as each object is created.

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

e - Top-level XML element containing the description

o - Implementation-specific Object needed for the conversion

store

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

Store the

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

storeDirectly

public static org.jdom2.Element storeDirectly(java.lang.Object o,
                                              java.lang.String fileName)

historyElement

static org.jdom2.Element historyElement(FileHistory r,
                                        int depth)

operationElement

static org.jdom2.Element operationElement(FileHistory.OperationMemo r,
                                          int depth)