javolution.xml

Class XMLFormat.Default

java.lang.Object

javolution.xml.XMLFormat<Object>

javolution.xml.XMLFormat.Default

Enclosing class:

XMLFormat<T>

public static class XMLFormat.Default
extends XMLFormat<Object>

Returns the default XML format for any object having a plain text format; this XML representation consists of the plain text representation of the object as a "value" attribute.

Nested Class Summary

Nested classes/interfaces inherited from class javolution.xml.XMLFormat

XMLFormat.Default, XMLFormat.InputElement, XMLFormat.OutputElement

Constructor Summary

Constructors

Constructor and Description
XMLFormat.Default() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isReferenceable() Indicates if the object serialized through this format can be referenced to (default true).
Object	newInstance(Class<?> cls, XMLFormat.InputElement xml) Allocates a new object of the specified class from the specified XML input element.
void	read(XMLFormat.InputElement xml, Object obj) Parses an XML input element into the specified object.
void	write(Object obj, XMLFormat.OutputElement xml) Formats an object into the specified XML output element.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLFormat.Default

public XMLFormat.Default()

Default constructor.

Method Detail

isReferenceable

public boolean isReferenceable()

Description copied from class: XMLFormat

Indicates if the object serialized through this format can be referenced to (default true). This method can be overriden to return false if serialized objects are manipulated "by value".

Overrides:

isReferenceable in class XMLFormat<Object>

Returns:

true if serialized object may hold a reference; false otherwise.

See Also:

XMLReferenceResolver

newInstance

public Object newInstance(Class<?> cls,
                 XMLFormat.InputElement xml)
                   throws XMLStreamException

Description copied from class: XMLFormat

Allocates a new object of the specified class from the specified XML input element. By default, this method returns an object created using the public no-arg constructor of the specified class. XML formats may override this method in order to use private/multi-arg constructors.

Overrides:

newInstance in class XMLFormat<Object>

Parameters:

cls - the class of the object to return.

xml - the XML input element.

Returns:

the object corresponding to the specified XML element.

Throws:

XMLStreamException

read

public void read(XMLFormat.InputElement xml,
        Object obj)
          throws XMLStreamException

Description copied from class: XMLFormat

Parses an XML input element into the specified object.

Specified by:

read in class XMLFormat<Object>

Parameters:

xml - the XML element to parse.

obj - the object created through XMLFormat.newInstance(java.lang.Class<? extends T>, javolution.xml.XMLFormat.InputElement) and to setup from the specified XML element.

Throws:

XMLStreamException

write

public void write(Object obj,
         XMLFormat.OutputElement xml)
           throws XMLStreamException

Description copied from class: XMLFormat

Formats an object into the specified XML output element.

Specified by:

write in class XMLFormat<Object>

Parameters:

obj - the object to format.

xml - the XMLElement destination.

Throws:

XMLStreamException