oracle.ide.marshal.xml

Interface ToDomConverter

All Known Subinterfaces:

ToDomConverter2

All Known Implementing Classes:

Color2Dom, Converters.TypeSafeEnumerationConverter

public interface ToDomConverter

Classes that implement this interface are capable of converting an object type (or types) into a DOM tree.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	toElement(ObjectWrapper wrapper, org.w3c.dom.Element element, java.lang.Class type, Object2Dom o2d) Populates the specified Element according to the state of the object in the ObjectWrapper using the specified Object2Dom instance for recursion.
boolean	toObject(ObjectWrapper wrapper, org.w3c.dom.Element element, java.lang.Class type, Object2Dom o2d) Creates an object of the given type that is represented by the contents of the specified Element parameter.

Method Detail

toElement

boolean toElement(ObjectWrapper wrapper,
                org.w3c.dom.Element element,
                java.lang.Class type,
                Object2Dom o2d)

Populates the specified Element according to the state of the object in the ObjectWrapper using the specified Object2Dom instance for recursion.

Implementations of this method should first check the specified type to determine if conversion is supported for that type.

Parameters:

wrapper - The ObjectWrapper containing the object to be converted.

element - The parent Element to which any newly created Elements should be appended.

type - The Class type of the object being converted to an Element.

o2d - The Object2Dom instance to use for recursion, if necessary.

Returns:

true if the conversion from object to Element occurred successfully; false otherwise.

toObject

boolean toObject(ObjectWrapper wrapper,
               org.w3c.dom.Element element,
               java.lang.Class type,
               Object2Dom o2d)

Creates an object of the given type that is represented by the contents of the specified Element parameter. The given Object2Dom is used for recursing into other objects.

Implementations of this method should first check the specified type to determine if conversion is supported for that type.

The object produced by this method must be set on the specified ObjectWrapper before this method returns. Additionally, if the ObjectWrapper already contains an object when this method is invoked, this method should unmarshal the specified Element's state into the existing object rather than creating a new one, if possible.

Parameters:

wrapper - The ObjectWrapper that wraps the object that results from unmarshalling the specified Element. If a pre-existing object is in the ObjectWrapper, this method should attempt to unmarshal the Element into the existing object rather than creating a new one.

element - The Element which is being unmarshalled into an object.

type - The Class type of the object being unmarshalled from an Element.

o2d - The Object2Dom instance to use for recursion, if necessary.

Returns:

true if the conversion from Element to object occurred successfully; false otherwise.