FreeHEP API
Version current

org.freehep.xml.io
Interface XMLIOProxy


public interface XMLIOProxy

Interface for proxyes that can save and restore objects to/from xml.

Author:
turri
Source Code:
XMLIOProxy.java

Method Summary
 void restore(Object obj, XMLIOManager xmlioManager, org.jdom.Element nodeEl)
          Restore the configuration of an object.
 void save(Object obj, XMLIOManager xmlioManager, org.jdom.Element nodeEl)
          Save the current configuration of an object.
 Class[] XMLIOProxyClasses()
          Returns the array containing the Class of the objects that the proxy is able to save and restore.
 

Method Detail

save

public void save(Object obj,
                 XMLIOManager xmlioManager,
                 org.jdom.Element nodeEl)
          throws IllegalArgumentException
Save the current configuration of an object.

Parameters:
obj - The object to be saved to xml.
xmlioManager - The objects ID manager.
Returns:
Element A jdom node containing the object's configuration info.
Throws:
An - IllegalArgumentException if the object is not saveble by this proxy.
IllegalArgumentException

restore

public void restore(Object obj,
                    XMLIOManager xmlioManager,
                    org.jdom.Element nodeEl)
             throws IllegalArgumentException
Restore the configuration of an object.

Parameters:
obj - The object to be restored.
xmlioManager - The objects ID manager.
nodeEl - Is the jdom node containing the object's configuration info
Throws:
An - IllegalArgumentException if the object cannot be restored by this proxy.
IllegalArgumentException

XMLIOProxyClasses

public Class[] XMLIOProxyClasses()
Returns the array containing the Class of the objects that the proxy is able to save and restore.

Returns:
The classes.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.