net.sf.practicalxml.converter.bean

Class Bean2XmlAppenders.Appender

java.lang.Object

net.sf.practicalxml.converter.bean.Bean2XmlAppenders.Appender

Direct Known Subclasses:

Bean2XmlAppenders.BasicAppender, Bean2XmlAppenders.DirectAppender

Enclosing class:

Bean2XmlAppenders

public abstract static class Bean2XmlAppenders.Appender
extends Object

An Appender appends children to a single node of the output tree. One instance is created for each non-leaf node; different object types use different appender classes, and the driver is responsible for picking the appropriate appender.

This base class maintains options and other state, and provides common services to subclasses. Subclasses implement the appendValue(java.lang.String, java.lang.Class<?>, java.lang.String) and appendContainer(java.lang.String, java.lang.Class<?>) methods, which are called by the driver.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Bean2XmlAppenders.Appender(Bean2XmlAppenders.Appender parent, Object nodeObject) Constructor called by all other subclasses.
protected	Bean2XmlAppenders.Appender(EnumSet<Bean2XmlOptions> options, Object rootObject) Constructor called by (@link DirectAppender).

Method Summary

Methods

Modifier and Type	Method and Description
abstract Element	appendContainer(String name, Class<?> klass) Appends a container element to the current element.
abstract Element	appendValue(String name, Class<?> klass, String value) Appends a value element to the current element.
protected boolean	isCircularReference(Object obj) Determines whether the passed object is a circular reference.
protected boolean	isOptionSet(Bean2XmlOptions option) Hides the mechanism that we used to manage options.
void	overrideType(Element elem, String typedesc) Updates the type attribute to the specified value, if types are in use; otherwise does nothing.
protected void	setType(Element elem, Class<?> klass) Optionally sets a type attribute on the generated element.
protected void	setValue(Element elem, String value) Sets the value of the generated element.
protected boolean	shouldSkip(Object value) Returns true to indicate whether the appender should not output the passed value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bean2XmlAppenders.Appender

protected Bean2XmlAppenders.Appender(EnumSet<Bean2XmlOptions> options,
                          Object rootObject)

Constructor called by (@link DirectAppender). This contains explicit defaults that are inherited by child appenders.

Parameters:

options - Options controlling the conversion.

rootObject - The root object being converted.

Bean2XmlAppenders.Appender

protected Bean2XmlAppenders.Appender(Bean2XmlAppenders.Appender parent,
                          Object nodeObject)

Constructor called by all other subclasses. Will inherit settings from parent.

Parameters:

parent - The parent appender. May not be null.

nodeObject - The object "owned" by this appender.

Method Detail

isOptionSet

protected boolean isOptionSet(Bean2XmlOptions option)

Hides the mechanism that we used to manage options.

isCircularReference

protected boolean isCircularReference(Object obj)

Determines whether the passed object is a circular reference.

shouldSkip

protected boolean shouldSkip(Object value)

Returns true to indicate whether the appender should not output the passed value. Also tests for circular references.

setType

protected void setType(Element elem,
           Class<?> klass)

Optionally sets a type attribute on the generated element.

overrideType

public void overrideType(Element elem,
                String typedesc)

Updates the type attribute to the specified value, if types are in use; otherwise does nothing. This is called when the type cannot be derived from the class of the appended object.

setValue

protected void setValue(Element elem,
            String value)

Sets the value of the generated element. Manages optional null handling.

appendValue

public abstract Element appendValue(String name,
                  Class<?> klass,
                  String value)

Appends a value element to the current element. Value elements have associated text, but no other children.

Parameters:

name - Name to be associated with the node.

klass - Java class for this node. May (depending on options) be stored in the type attribute.

value - The node's value. May be null, in which case the appender decides whether or not to actually append the node.

Returns:

The appended element. This is a convenience for subclasses, which may want to set additional attributes after their super has done the work of appending the element.

Throws:

ConversionException - if unable to append the node.

appendContainer

public abstract Element appendContainer(String name,
                      Class<?> klass)

Appends a container element to the current element. Container elements have other elements as children, and may have a type, but do not have an associated value.