org.nanoj.util.beanwriter

Class XmlBeanTranslator

java.lang.Object

org.nanoj.util.beanwriter.XmlBeanTranslator

All Implemented Interfaces:

BeanTranslator

public class XmlBeanTranslator
extends Object
implements BeanTranslator

XML implementation for BeanWriter

Author:

Laurent Guerin

Constructor Summary

Constructors

Constructor and Description
XmlBeanTranslator() Creates a new XML translator By default the output will not be formated
XmlBeanTranslator(boolean formattedOutput) Creates a new XML translator
XmlBeanTranslator(boolean formattedOutput, String rootTag) Creates a new XML translator

Method Summary

Methods

Modifier and Type	Method and Description
void	close(Writer output)
void	closeArray(Writer output, Object[] array, String name, Object parent)
void	closeCollection(Writer output, Collection<?> collection, String name, Object parent)
void	closeObject(Writer output, Object bean, String name, int subObjectsCount)
void	closeSubObjects(Writer output, Object bean, String name)
void	open(Writer output)
void	openArray(Writer output, Object[] array, String name, Object parent)
void	openCollection(Writer output, Collection<?> collection, String name, Object parent)
void	openObject(Writer output, Object bean, String name)
void	openSubObjects(Writer output, Object bean, String name)
void	setNullTag(String nullTag) Set the name of the tag used for null objects ( the default is "null" and the output is "" If the tag name is set to null then no null tag will be written
void	setWriteNullAttribute(boolean flag) Define if this writer must generate void attribute values for null values or not If true : an attribute like firstName="" will be generated if the firstName property is null If false : no attribute will be generated if the property is null The default value is true.
void	writeComment(Writer output, String comment) Write a comment
void	writeNullValue(Writer output, String name, Object parent) Write a null value
void	writeSubElementValue(Writer output, Object value, String name, Object parent) Write a basic value as a "sub-element"
void	writeValue(Writer output, Object obj, String name, Object parent) Write a basic value

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlBeanTranslator

public XmlBeanTranslator()

Creates a new XML translator
By default the output will not be formated

XmlBeanTranslator

public XmlBeanTranslator(boolean formattedOutput)

Creates a new XML translator

Parameters:

formattedOutput - indicates if the output must be formated or not

XmlBeanTranslator

public XmlBeanTranslator(boolean formattedOutput,
                 String rootTag)

Creates a new XML translator

Parameters:

formattedOutput - indicates if the output must be formated or not

rootTag - the name to be used as the XML root tag

Method Detail

setNullTag

public void setNullTag(String nullTag)

Set the name of the tag used for null objects ( the default is "null" and the output is ""
If the tag name is set to null then no null tag will be written

Parameters:

nullTag - the name of the null tag ( ie "NullObject" for , or null for none )

setWriteNullAttribute

public void setWriteNullAttribute(boolean flag)

Define if this writer must generate void attribute values for null values or not
If true : an attribute like firstName="" will be generated if the firstName property is null
If false : no attribute will be generated if the property is null
The default value is true.

Parameters:

flag -

open

public void open(Writer output)

Specified by:

open in interface BeanTranslator

close

public void close(Writer output)

Specified by:

close in interface BeanTranslator

openSubObjects

public void openSubObjects(Writer output,
                  Object bean,
                  String name)

Specified by:

openSubObjects in interface BeanTranslator

closeSubObjects

public void closeSubObjects(Writer output,
                   Object bean,
                   String name)

Specified by:

closeSubObjects in interface BeanTranslator

openObject

public void openObject(Writer output,
              Object bean,
              String name)

Specified by:

openObject in interface BeanTranslator

closeObject

public void closeObject(Writer output,
               Object bean,
               String name,
               int subObjectsCount)

Specified by:

closeObject in interface BeanTranslator

writeComment

public void writeComment(Writer output,
                String comment)

Description copied from interface: BeanTranslator

Write a comment

Specified by:

writeComment in interface BeanTranslator

writeNullValue

public void writeNullValue(Writer output,
                  String name,
                  Object parent)

Description copied from interface: BeanTranslator

Write a null value

Specified by:

writeNullValue in interface BeanTranslator

name - the name of the value

parent - the parent object

writeValue

public void writeValue(Writer output,
              Object obj,
              String name,
              Object parent)

Description copied from interface: BeanTranslator

Write a basic value

Specified by:

writeValue in interface BeanTranslator

obj - the value to write ( String, Number, Boolean, etc )

name - the name of the value

parent - the parent object

writeSubElementValue

public void writeSubElementValue(Writer output,
                        Object value,
                        String name,
                        Object parent)

Description copied from interface: BeanTranslator

Write a basic value as a "sub-element"

Specified by:

writeSubElementValue in interface BeanTranslator

value - the value to write ( String, Number, Boolean, etc )

name - the name of the value

parent - the parent object

openArray

public void openArray(Writer output,
             Object[] array,
             String name,
             Object parent)

Specified by:

openArray in interface BeanTranslator

closeArray

public void closeArray(Writer output,
              Object[] array,
              String name,
              Object parent)

Specified by:

closeArray in interface BeanTranslator

openCollection

public void openCollection(Writer output,
                  Collection<?> collection,
                  String name,
                  Object parent)

Specified by:

openCollection in interface BeanTranslator

closeCollection

public void closeCollection(Writer output,
                   Collection<?> collection,
                   String name,
                   Object parent)

Specified by:

closeCollection in interface BeanTranslator