dsto.dfc.databeans.io
Class XmlAwtCodec

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

All Implemented Interfaces:

XmlDecoder, XmlEncoder

public class XmlAwtCodec
extends Object
implements XmlEncoder, XmlDecoder

General XML codec for AWT data structures. Currently handles RGB colours (java.awt.Color in default colour space), java.awt.Point, java.awt.geom.Point2D family (Point2D.Float and Point2D.Double), java.awt.Rectangle, and the java.awt.geom.Rectangle2D family (Rectangle2D.Float and Rectangle2D.Double).

Author:

Matthew Phillips

Constructor Summary

XmlAwtCodec()

Method Summary

boolean	canEncode(XmlEncodeContext context, Object value) Test if this codec can encode a given object.
Object	decode(XmlDecodeContext context, org.jdom.Element element) Decode an XML representation into a value.
org.jdom.Element	encode(XmlEncodeContext context, Object value) Generate an XML representation of an object.
static void	register()
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

XmlAwtCodec

public XmlAwtCodec()

Method Detail

register

public static void register()

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.

decode

public Object decode(XmlDecodeContext context,
                     org.jdom.Element element)
              throws IllegalArgumentException

Description copied from interface: XmlDecoder

Decode an XML representation into a value.

Specified by:

decode in interface XmlDecoder

Parameters:

context - The decode context.

element - The element to decode.

Returns:

The new object.

Throws:

IllegalArgumentException - if an error is found in the structure of the document.