javolution.xml.XMLFormat< T >.OutputElement Class Reference

Collaboration diagram for javolution.xml.XMLFormat< T >.OutputElement:

Public Member Functions
XMLStreamWriter	getStreamWriter ()
void	add (Object obj) throws XMLStreamException
void	add (Object obj, String name) throws XMLStreamException
void	add (Object obj, String localName, String uri) throws XMLStreamException
void	addText (CharSequence text) throws XMLStreamException
void	addText (String text) throws XMLStreamException
void	setAttribute (String name, CharSequence value) throws XMLStreamException
void	setAttribute (String name, String value) throws XMLStreamException
void	setAttribute (String name, boolean value) throws XMLStreamException
void	setAttribute (String name, char value) throws XMLStreamException
void	setAttribute (String name, byte value) throws XMLStreamException
void	setAttribute (String name, short value) throws XMLStreamException
void	setAttribute (String name, int value) throws XMLStreamException
void	setAttribute (String name, long value) throws XMLStreamException
void	setAttribute (String name, float value) throws XMLStreamException
void	setAttribute (String name, double value) throws XMLStreamException
void	setAttribute (String name, Object value) throws XMLStreamException

Package Functions
	OutputElement ()
public< T > void	add (T obj, String name, Class< T > cls) throws XMLStreamException
public< T > void	add (T obj, String localName, String uri, Class< T > cls) throws XMLStreamException
void	setBinding (XMLBinding xmlBinding)
void	setReferenceResolver (XMLReferenceResolver xmlReferenceResolver)
void	reset ()

Package Attributes
final XMLStreamWriterImpl	_writer = new XMLStreamWriterImpl()

Private Member Functions
boolean	writeReference (Object obj) throws XMLStreamException

Private Attributes
XMLBinding	_binding
XMLReferenceResolver	_referenceResolver
TextBuilder	_tmpTextBuilder = new TextBuilder()

Detailed Description

This class represents an output XML element (marshalling).

Definition at line 622 of file XMLFormat.java.

Constructor & Destructor Documentation

OutputElement()

javolution.xml.XMLFormat< T >.OutputElement.OutputElement ( )

package

Default constructor.

Definition at line 642 of file XMLFormat.java.

                        {
            reset();
        }

Member Function Documentation

add() [1/5]

void javolution.xml.XMLFormat< T >.OutputElement.add

(

Object

obj

)

throws XMLStreamException

Adds the specified object or null as an anonymous nested element of unknown type.

Parameters

obj	the object added as nested element or null.

Definition at line 662 of file XMLFormat.java.

                                                              {
            if (obj == null) {
                _writer.writeEmptyElement(NULL);
                return;
            }
 
            // Writes start element.
            Class<?> cls = obj.getClass();
            _binding.writeClass(cls, _writer, false);
 
            // Checks if reference written.
            XMLFormat<Object> xmlFormat = (XMLFormat<Object>) _binding
                    .getFormat(cls);
            if (xmlFormat.isReferenceable() && writeReference(obj))
                return;
 
            xmlFormat.write(obj, this);
            _writer.writeEndElement();
        }

References javolution.xml.XMLFormat< T >.isReferenceable(), javolution.xml.XMLFormat< T >.NULL, javolution.xml.XMLFormat< T >.write(), javolution.xml.XMLBinding.writeClass(), javolution.xml.internal.stream.XMLStreamWriterImpl.writeEmptyElement(), and javolution.xml.internal.stream.XMLStreamWriterImpl.writeEndElement().

Here is the call graph for this function:

add() [2/5]

void javolution.xml.XMLFormat< T >.OutputElement.add	(	Object	obj,
		String	localName,
		String	uri
	)		throws XMLStreamException

Adds the specified object as a fully qualified nested element of unknown type (null objects are ignored). The nested XML element contains a class attribute identifying the object type.

Parameters

obj	the object added as nested element or null.
localName	the local name of the nested element.
uri	the namespace URI of the nested element.

Definition at line 722 of file XMLFormat.java.

                                          {
            if (obj == null)
                return;
 
            // Writes start element.
            _writer.writeStartElement(uri, localName);
 
            // Writes class attribute.
            Class<?> cls = obj.getClass();
            _binding.writeClass(cls, _writer, true);
 
            // Checks if reference written.
            XMLFormat<Object> xmlFormat = (XMLFormat<Object>) _binding
                    .getFormat(cls);
            if (xmlFormat.isReferenceable() && writeReference(obj))
                return;
 
            xmlFormat.write(obj, this);
            _writer.writeEndElement();
        }

References javolution.xml.XMLFormat< T >.isReferenceable(), javolution.xml.XMLFormat< T >.write(), javolution.xml.XMLBinding.writeClass(), javolution.xml.internal.stream.XMLStreamWriterImpl.writeEndElement(), and javolution.xml.internal.stream.XMLStreamWriterImpl.writeStartElement().

Here is the call graph for this function:

add() [3/5]

void javolution.xml.XMLFormat< T >.OutputElement.add	(	Object	obj,
		String	name
	)		throws XMLStreamException

Adds the specified object as a named nested element of unknown type (null objects are ignored). The nested XML element contains a class attribute identifying the object type.

Parameters

obj	the object added as nested element or null.
name	the name of the nested element.

Definition at line 691 of file XMLFormat.java.

                                                                           {
            if (obj == null)
                return;
 
            // Writes start element.
            _writer.writeStartElement(name);
 
            // Writes class attribute.
            Class<?> cls = obj.getClass();
            _binding.writeClass(cls, _writer, true);
 
            // Checks if reference written.
            XMLFormat<Object> xmlFormat = (XMLFormat<Object>) _binding
                    .getFormat(cls);
            if (xmlFormat.isReferenceable() && writeReference(obj))
                return;
 
            xmlFormat.write(obj, this);
            _writer.writeEndElement();
        }

References javolution.xml.XMLFormat< T >.isReferenceable(), javolution.xml.XMLFormat< T >.write(), javolution.xml.XMLBinding.writeClass(), javolution.xml.internal.stream.XMLStreamWriterImpl.writeEndElement(), and javolution.xml.internal.stream.XMLStreamWriterImpl.writeStartElement().

Here is the call graph for this function:

add() [4/5]

public<T> void javolution.xml.XMLFormat< T >.OutputElement.add ( T  obj, String  localName, String  uri, Class< T >  cls  ) throws XMLStreamException

package

Adds the specified object as a fully qualified nested element of specified actual type (null objects are ignored). The nested XML element does not contain any class attribute.

Parameters

obj	the object added as nested element or null.
localName	the local name of the nested element.
uri	the namespace URI of the nested element.
cls	the class identifying the format of the specified object.

Definition at line 780 of file XMLFormat.java.

                                          {
            if (obj == null)
                return;
 
            // Writes start element.
            _writer.writeStartElement(uri, localName);
 
            // Checks if reference written.
            XMLFormat<T> xmlFormat = (XMLFormat<T>) _binding.getFormat(cls);
            if (xmlFormat.isReferenceable() && writeReference(obj))
                return;
 
            xmlFormat.write(obj, this);
            _writer.writeEndElement();
        }

References javolution.xml.XMLBinding.getFormat(), javolution.xml.XMLFormat< T >.isReferenceable(), javolution.xml.XMLFormat< T >.write(), javolution.xml.internal.stream.XMLStreamWriterImpl.writeEndElement(), and javolution.xml.internal.stream.XMLStreamWriterImpl.writeStartElement().

Here is the call graph for this function:

add() [5/5]

public<T> void javolution.xml.XMLFormat< T >.OutputElement.add ( T  obj, String  name, Class< T >  cls  ) throws XMLStreamException

package

Adds the specified object as a named nested element of specified
actual type (null objects are ignored). The nested XML element does not contain any class attribute.

Parameters

obj	the object added as nested element or null.
name	the name of the nested element.
cls	the class identifying the format of the specified object.

Definition at line 753 of file XMLFormat.java.

                                          {
            if (obj == null)
                return;
 
            // Writes start element.
            _writer.writeStartElement(name);
 
            // Checks if reference written.
            XMLFormat<T> xmlFormat = (XMLFormat<T>) _binding.getFormat(cls);
            if (xmlFormat.isReferenceable() && writeReference(obj))
                return;
 
            xmlFormat.write(obj, this);
            _writer.writeEndElement();
        }

References javolution.xml.XMLBinding.getFormat(), javolution.xml.XMLFormat< T >.isReferenceable(), javolution.xml.XMLFormat< T >.write(), javolution.xml.internal.stream.XMLStreamWriterImpl.writeEndElement(), and javolution.xml.internal.stream.XMLStreamWriterImpl.writeStartElement().

Here is the call graph for this function:

addText() [1/2]

void javolution.xml.XMLFormat< T >.OutputElement.addText

(

CharSequence

text

)

throws XMLStreamException

Adds the content of a text-only element (equivalent to getStreamWriter().writeCharacters(text)).

Parameters

text	the element text content or an empty sequence if none.

Definition at line 813 of file XMLFormat.java.

                                                                         {
            _writer.writeCharacters(text);
        }

References javolution.xml.internal.stream.XMLStreamWriterImpl.writeCharacters().

Here is the call graph for this function:

addText() [2/2]

void javolution.xml.XMLFormat< T >.OutputElement.addText

(

String

text

)

throws XMLStreamException

Equivalent to addText(CharSequence) (for J2ME compatibility).

Parameters

text	the element text content or an empty sequence if none.

Definition at line 823 of file XMLFormat.java.

                                                                   {
            _writer.writeCharacters(text);
        }

References javolution.xml.internal.stream.XMLStreamWriterImpl.writeCharacters().

Here is the call graph for this function:

getStreamWriter()

XMLStreamWriter javolution.xml.XMLFormat< T >.OutputElement.getStreamWriter

(

)

Returns the StAX-like stream writer (provides complete control over the marshalling process).

Returns

the stream writer.

Definition at line 652 of file XMLFormat.java.

                                                 {
            return _writer;
        }

reset()

void javolution.xml.XMLFormat< T >.OutputElement.reset ( )

package

Definition at line 972 of file XMLFormat.java.

                     {
            _binding = XMLBinding.DEFAULT;
            _writer.reset();
            _writer.setRepairingNamespaces(true);
            _writer.setAutomaticEmptyElements(true);
            _referenceResolver = null;
        }

References javolution.xml.XMLBinding.DEFAULT, javolution.xml.internal.stream.XMLStreamWriterImpl.reset(), javolution.xml.internal.stream.XMLStreamWriterImpl.setAutomaticEmptyElements(), and javolution.xml.internal.stream.XMLStreamWriterImpl.setRepairingNamespaces().

Here is the call graph for this function:

setAttribute() [1/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		boolean	value
	)		throws XMLStreamException

Sets the specified boolean attribute.

Parameters

name	the attribute name.
value	the boolean value for the specified attribute.

Definition at line 861 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

setAttribute() [2/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		byte	value
	)		throws XMLStreamException

Sets the specified byte attribute.

Parameters

name	the attribute name.
value	the byte value for the specified attribute.

Definition at line 886 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [3/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		char	value
	)		throws XMLStreamException

Sets the specified char attribute.

Parameters

name	the attribute name.
value	the char value for the specified attribute.

Definition at line 874 of file XMLFormat.java.

                                          {
            setAttribute(name,
                    (TextBuilder) _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [4/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		CharSequence	value
	)		throws XMLStreamException

Sets the specified CharSequence attribute (null values are ignored).

Parameters

name	the attribute name.
value	the attribute value or null.

Definition at line 834 of file XMLFormat.java.

                                          {
            if (value == null)
                return;
            _writer.writeAttribute(name, value);
        }

References javolution.xml.internal.stream.XMLStreamWriterImpl.writeAttribute().

Here is the call graph for this function:

setAttribute() [5/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		double	value
	)		throws XMLStreamException

Sets the specified double attribute.

Parameters

name	the attribute name.
value	the double value for the specified attribute.

Definition at line 941 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [6/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		float	value
	)		throws XMLStreamException

Sets the specified float attribute.

Parameters

name	the attribute name.
value	the float value for the specified attribute.

Definition at line 930 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [7/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		int	value
	)		throws XMLStreamException

Sets the specified int attribute.

Parameters

name	the attribute name.
value	the int value for the specified attribute.

Definition at line 908 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [8/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		long	value
	)		throws XMLStreamException

Sets the specified long attribute.

Parameters

name	the attribute name.
value	the long value for the specified attribute.

Definition at line 919 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [9/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		Object	value
	)		throws XMLStreamException

Sets the specified attribute using its associated TextFormat.

Parameters

name	the name of the attribute.
value	the value for the specified attribute or null in which case the attribute is not set.

Definition at line 954 of file XMLFormat.java.

                                          {
            if (value == null)
                return;
            setAttribute(name, _tmpTextBuilder.clear().append(value.toString()));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [10/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		short	value
	)		throws XMLStreamException

Sets the specified short attribute.

Parameters

name	the attribute name.
value	the short value for the specified attribute.

Definition at line 897 of file XMLFormat.java.

                                          {
            setAttribute(name, _tmpTextBuilder.clear().append(value));
        }

References javolution.text.TextBuilder.append(), and javolution.text.TextBuilder.clear().

Here is the call graph for this function:

setAttribute() [11/11]

void javolution.xml.XMLFormat< T >.OutputElement.setAttribute	(	String	name,
		String	value
	)		throws XMLStreamException

Sets the specified String attribute (null values are ignored).

Parameters

name	the attribute name.
value	the attribute value.

Definition at line 848 of file XMLFormat.java.

                                          {
            if (value == null)
                return;
            _writer.writeAttribute(name, value);
        }

References javolution.xml.internal.stream.XMLStreamWriterImpl.writeAttribute().

Here is the call graph for this function:

setBinding()

void javolution.xml.XMLFormat< T >.OutputElement.setBinding ( XMLBinding  xmlBinding )

package

Definition at line 962 of file XMLFormat.java.

                                               {
            _binding = xmlBinding;
        }

setReferenceResolver()

void javolution.xml.XMLFormat< T >.OutputElement.setReferenceResolver ( XMLReferenceResolver  xmlReferenceResolver )

package

Definition at line 967 of file XMLFormat.java.

                                                                             {
            _referenceResolver = xmlReferenceResolver;
        }

writeReference()

boolean javolution.xml.XMLFormat< T >.OutputElement.writeReference ( Object  obj ) throws XMLStreamException

private

Definition at line 798 of file XMLFormat.java.

                                                                             {
            if ((_referenceResolver == null)
                    || !_referenceResolver.writeReference(obj, this))
                return false;
            _writer.writeEndElement();
            return true; // Reference written.
        }

References javolution.xml.internal.stream.XMLStreamWriterImpl.writeEndElement(), and javolution.xml.XMLReferenceResolver.writeReference().

Here is the call graph for this function:

Member Data Documentation

_binding

XMLBinding javolution.xml.XMLFormat< T >.OutputElement._binding

private

Holds the XML binding.

Definition at line 632 of file XMLFormat.java.

_referenceResolver

XMLReferenceResolver javolution.xml.XMLFormat< T >.OutputElement._referenceResolver

private

Holds the reference resolver.

Definition at line 637 of file XMLFormat.java.

_tmpTextBuilder

TextBuilder javolution.xml.XMLFormat< T >.OutputElement._tmpTextBuilder = new TextBuilder()

private

Definition at line 866 of file XMLFormat.java.

_writer

final XMLStreamWriterImpl javolution.xml.XMLFormat< T >.OutputElement._writer = new XMLStreamWriterImpl()

package

Holds the stream writer.

Definition at line 627 of file XMLFormat.java.

---

The documentation for this class was generated from the following file:

• XMLFormat.java