org.simpleframework.xml.convert

Class RegistryStrategy

java.lang.Object

org.simpleframework.xml.convert.RegistryStrategy

All Implemented Interfaces:

Strategy

public class RegistryStrategy
extends Object
implements Strategy

The RegistryStrategy object is used to intercept the serialization process and delegate to custom converters. The custom converters are resolved from a Registry object, which is provided to the constructor. If there is no binding for a particular object then serialization is delegated to an internal strategy. All converters resolved by this are instantiated once and cached internally for performance.

By default the TreeStrategy is used to perform the normal serialization process should there be no class binding specifying a converter to use. However, any implementation can be used, including the CycleStrategy, which handles cycles in the object graph. To specify the internal strategy to use it can be provided in the constructor.

See Also:

Registry

Constructor Summary

Constructors

Constructor and Description
RegistryStrategy(Registry registry) Constructor for the RegistryStrategy object.
RegistryStrategy(Registry registry, Strategy strategy) Constructor for the RegistryStrategy object.

Method Summary

Modifier and Type	Method and Description
Value	read(Type type, NodeMap<InputNode> node, Map map) This is used to read the Value which will be used to represent the deserialized object.
boolean	write(Type type, Object value, NodeMap<OutputNode> node, Map map) This is used to serialize a representation of the object value provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryStrategy

public RegistryStrategy(Registry registry)

Constructor for the RegistryStrategy object. This is used to create a strategy that will intercept the normal serialization process by searching for bindings within the provided Registry instance.

Parameters:

registry - this is the registry instance with bindings

RegistryStrategy

public RegistryStrategy(Registry registry,
                        Strategy strategy)

Constructor for the RegistryStrategy object. This is used to create a strategy that will intercept the normal serialization process by searching for bindings within the provided Registry instance.

Parameters:

registry - this is the registry instance with bindings

strategy - this is the strategy to delegate to

Method Detail

read

public Value read(Type type,
                  NodeMap<InputNode> node,
                  Map map)
           throws Exception

This is used to read the Value which will be used to represent the deserialized object. If there is an binding present then the value will contain an object instance. If it does not then it is up to the internal strategy to determine what the returned value contains.

Specified by:

read in interface Strategy

Parameters:

type - this is the type that represents a method or field

node - this is the node representing the XML element

map - this is the session map that contain variables

Returns:

the value representing the deserialized value

Throws:

Exception - thrown if the class cannot be resolved

write

public boolean write(Type type,
                     Object value,
                     NodeMap<OutputNode> node,
                     Map map)
              throws Exception

This is used to serialize a representation of the object value provided. If there is a Registry binding present for the provided type then this will use the converter specified to serialize a representation of the object. If however there is no binding present then this will delegate to the internal strategy. This returns true if the serialization has completed.

Specified by:

write in interface Strategy

Parameters:

type - this is the type that represents the field or method

value - this is the object instance to be serialized

node - this is the XML element to be serialized to

map - this is the session map used by the serializer

Returns:

this returns true if it was serialized, false otherwise

Throws:

Exception - thrown if the details cannot be set