dsto.dfc.databeans.io
Class XmlDefaultEncoder

java.lang.Object
  dsto.dfc.databeans.io.XmlDefaultEncoder

All Implemented Interfaces:

XmlEncoder

public class XmlDefaultEncoder
extends Object
implements XmlEncoder

Default XML fallback encoder. This encoder can encode any object that (in order of preference):

• Is an array.
• Has a defined TextEncoder (see XmlOutput.registerTextEncoder(TextEncoder)
• Is null

Version:

$Revision$

Author:

mpp

See Also:

XmlDefaultDecoder

Constructor Summary

XmlDefaultEncoder()


Method Summary

boolean	canEncode(XmlEncodeContext context, Object value) Test if this codec can encode a given object.
org.jdom.Element	encode(XmlEncodeContext context, Object value) Generate an XML representation of an object.
protected void	encodeArray(XmlEncodeContext context, org.jdom.Element element, Object array) Encode an array.
protected void	encodeText(XmlEncodeContext context, org.jdom.Element element, Object value) Encode an object as text using a TextEncoder.
boolean	shouldPreserveIdentity(XmlEncodeContext context, Object value) Return true if the identity of the given value should be preserved.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDefaultEncoder

public XmlDefaultEncoder()

Method Detail

shouldPreserveIdentity

public boolean shouldPreserveIdentity(XmlEncodeContext context,
                                      Object value)

Description copied from interface: XmlEncoder

Return true if the identity of the given value should be preserved. If true, any instances of the object after the first will be written out as references to the original rather than a copy.

Specified by:

shouldPreserveIdentity in interface XmlEncoder

canEncode

public boolean canEncode(XmlEncodeContext context,
                         Object value)

Description copied from interface: XmlEncoder

Test if this codec can encode a given object.

Specified by:

canEncode in interface XmlEncoder

Parameters:

context - The current encode context.

value - The value. May be null.

Returns:

True if this encoder should be used for value.

encode

public org.jdom.Element encode(XmlEncodeContext context,
                               Object value)

Description copied from interface: XmlEncoder

Generate an XML representation of an object.

Specified by:

encode in interface XmlEncoder

Parameters:

context - The encoding context.

value - The value to be encoded.

Returns:

The JDOM element created for the value.

encodeArray

protected void encodeArray(XmlEncodeContext context,
                           org.jdom.Element element,
                           Object array)

Encode an array.

encodeText

protected void encodeText(XmlEncodeContext context,
                          org.jdom.Element element,
                          Object value)

Encode an object as text using a TextEncoder.