jmri.configurexml
Class DefaultJavaBeanConfigXML

Show UML class diagram
java.lang.Object
  extended by jmri.configurexml.AbstractXmlAdapter
      extended by jmri.configurexml.DefaultJavaBeanConfigXML
All Implemented Interfaces:
XmlAdapter

public class DefaultJavaBeanConfigXML
extends AbstractXmlAdapter

Provides services for storing Java Beans to XML using reflection.

Since:
2.3.1

Field Summary
(package private) static org.slf4j.Logger log
           
 
Constructor Summary
DefaultJavaBeanConfigXML()
           
 
Method Summary
(package private)  boolean getAttributeBool(org.jdom.Element elem, String name, boolean def)
          Get an attribute boolean value from an Element defining a NamedBean
(package private)  String getAttributeString(org.jdom.Element elem, String name)
          Get an attribute string value from an Element defining a NamedBean
 boolean load(org.jdom.Element e)
          Create a set of configured objects from their XML description
 void load(org.jdom.Element e, Object o)
          Create a set of configured objects from their XML description, using an auxiliary object.
 org.jdom.Element store(Object o)
          Store the
(package private)  Object unpack(org.jdom.Element e)
           
 
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

log

static org.slf4j.Logger log
Constructor Detail

DefaultJavaBeanConfigXML

public DefaultJavaBeanConfigXML()
Method Detail

load

public boolean load(org.jdom.Element e)
             throws Exception
Description copied from interface: XmlAdapter
Create a set of configured objects from their XML description

Parameters:
e - Top-level XML element containing the description
Returns:
true if successful
Throws:
Exception - when a error prevents creating the objects as as required by the input XML.

load

public void load(org.jdom.Element e,
                 Object o)
          throws Exception
Description copied from interface: XmlAdapter
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.

Parameters:
e - Top-level XML element containing the description
o - Implementation-specific Object needed for the conversion
Throws:
Exception - when a error prevents creating the objects as as required by the input XML.

unpack

Object unpack(org.jdom.Element e)
        throws Exception
Throws:
Exception

store

public org.jdom.Element store(Object o)
Description copied from interface: XmlAdapter
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

getAttributeString

String getAttributeString(org.jdom.Element elem,
                          String name)
Get an attribute string value from an Element defining a NamedBean

Parameters:
elem - The existing Element
name - name of desired Attribute

getAttributeBool

boolean getAttributeBool(org.jdom.Element elem,
                         String name,
                         boolean def)
Get an attribute boolean value from an Element defining a NamedBean

Parameters:
elem - The existing Element
name - Name of desired Attribute
def - Default value for attribute


Copyright © 1997-2013 JMRI Community.
JMRI, DecoderPro, PanelPro, SoundPro, DispatcherPro and associated logos are our trademarks.

Additional information on copyright, trademarks and licenses is linked here.
Site hosted by: Get JMRI Model Railroad Interface at SourceForge.net. Fast, secure and Free Open Source software downloads