Package org.glassfish.jaxb.runtime.v2.runtime

Class BinderImpl<XmlNode>

java.lang.Object

jakarta.xml.bind.Binder<XmlNode>

org.glassfish.jaxb.runtime.v2.runtime.BinderImpl<XmlNode>

public class BinderImpl<XmlNode>
extends Binder<XmlNode>

Implementation of Binder. TODO: investigate how much in-place unmarshalling is implemented - some preliminary work is there. Probably buggy. TODO: work on the marshaller side.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Method Summary

Modifier and Type	Method	Description
ValidationEventHandler	getEventHandler()	Return the current event handler or the default event handler if one hasn't been set.
Object	getJAXBNode(XmlNode xmlNode)	Gets the Jakarta XML Binding object associated with the given XML element.
Marshaller.Listener	getMarshallerListener()
Object	getProperty(String name)	Get the particular property in the underlying implementation of Binder.
Schema	getSchema()	Gets the last Schema object (including null) set by the Binder.setSchema(Schema) method.
Unmarshaller.Listener	getUnmarshallerListener()
XmlNode	getXMLNode(Object jaxbObject)	Gets the XML element associated with the given Jakarta XML Binding object.
void	marshal(Object jaxbObject, XmlNode xmlNode)	Marshal a Jakarta XML Binding object tree to a new XML document.
void	setEventHandler(ValidationEventHandler handler)	Allow an application to register a ValidationEventHandler.
void	setMarshallerListener(Marshaller.Listener listener)
void	setProperty(String name, Object value)	Set the particular property in the underlying implementation of Binder.
void	setSchema(Schema schema)	Specifies whether marshal, unmarshal and update methods performs validation on their XML content.
void	setUnmarshallerListener(Unmarshaller.Listener listener)
Object	unmarshal(XmlNode xmlNode)	Unmarshal XML infoset view to a Jakarta XML Binding object tree.
<T> JAXBElement<T>	unmarshal(XmlNode xmlNode, Class<T> expectedType)	Unmarshal XML root element by provided declaredType to a Jakarta XML Binding object tree.
Object	updateJAXB(XmlNode xmlNode)	Takes an XML node and updates its associated Jakarta XML Binding object and its descendants.
XmlNode	updateXML(Object jaxbObject)	Takes an Jakarta XML Binding object and updates its associated XML node and its descendants.
XmlNode	updateXML(Object jaxbObject, XmlNode xmlNode)	Changes in Jakarta XML Binding object tree are updated in its associated XML parse tree.

Methods inherited from class java.lang.Object

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

Method Detail

marshal

public void marshal(Object jaxbObject,
                    XmlNode xmlNode)
             throws JAXBException

Description copied from class: Binder

Marshal a Jakarta XML Binding object tree to a new XML document.

This method is similar to Marshaller.marshal(Object, Node) with the addition of maintaining the association between Jakarta XML Binding objects and the produced XML nodes, enabling future update operations such as Binder.updateXML(Object, Object) or Binder.updateJAXB(Object).

When Binder.getSchema() is non-null, the marshalled xml content is validated during this operation.

Specified by:

marshal in class Binder<XmlNode>

Parameters:

jaxbObject - The content tree to be marshalled.

xmlNode - The parameter must be a Node that accepts children.

Throws:

JAXBException - If any unexpected problem occurs during the marshalling.

MarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Binder is unable to marshal jaxbObject (or any object reachable from jaxbObject).

updateJAXB

public Object updateJAXB(XmlNode xmlNode)
                  throws JAXBException

Description copied from class: Binder

Takes an XML node and updates its associated Jakarta XML Binding object and its descendants.

This operation can be thought of as an "in-place" unmarshalling. The difference is that instead of creating a whole new Jakarta XML Binding tree, this operation updates an existing tree, reusing as much Jakarta XML Binding objects as possible.

As a side-effect, this operation updates the association between XML nodes and Jakarta XML Binding objects.

Specified by:

updateJAXB in class Binder<XmlNode>

Returns:

Returns the updated Jakarta XML Binding object. Typically, this is the same object that was returned from earlier Binder.marshal(Object,Object) or Binder.updateJAXB(Object) method invocation, but it maybe a different object, for example when the name of the XML element has changed.

Throws:

JAXBException - If any unexpected problem occurs updating corresponding Jakarta XML Binding mapped content.

unmarshal

public Object unmarshal(XmlNode xmlNode)
                 throws JAXBException

Description copied from class: Binder

Unmarshal XML infoset view to a Jakarta XML Binding object tree.

This method is similar to Unmarshaller.unmarshal(Node) with the addition of maintaining the association between XML nodes and the produced Jakarta XML Binding objects, enabling future update operations, Binder.updateXML(Object, Object) or Binder.updateJAXB(Object).

When Binder.getSchema() is non-null, xmlNode and its descendants is validated during this operation.

This method throws UnmarshalException when the Binder's JAXBContext does not have a mapping for the XML element name or the type, specifiable via @xsi:type, of xmlNode to a Jakarta XML Binding mapped class. The method Binder.unmarshal(Object, Class) enables an application to specify the Jakarta XML Binding mapped class that the xmlNode should be mapped to.

Specified by:

unmarshal in class Binder<XmlNode>

Parameters:

xmlNode - the document/element to unmarshal XML data from.

Returns:

the newly created root object of the Jakarta XML Binding object tree.

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Binder is unable to perform the XML to Java binding.

unmarshal

public <T> JAXBElement<T> unmarshal(XmlNode xmlNode,
                                    Class<T> expectedType)
                             throws JAXBException

Description copied from class: Binder

Unmarshal XML root element by provided declaredType to a Jakarta XML Binding object tree.

Implements Unmarshal by Declared Type

This method is similar to Unmarshaller.unmarshal(Node, Class) with the addition of maintaining the association between XML nodes and the produced Jakarta XML Binding objects, enabling future update operations, Binder.updateXML(Object, Object) or Binder.updateJAXB(Object).

When Binder.getSchema() is non-null, xmlNode and its descendants is validated during this operation.

Specified by:

unmarshal in class Binder<XmlNode>

Parameters:

xmlNode - the document/element to unmarshal XML data from.

expectedType - appropriate Jakarta XML Binding mapped class to hold node's XML data.

Returns:

JAXBElement representation of node

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Binder is unable to perform the XML to Java binding.

setSchema

public void setSchema(Schema schema)

Description copied from class: Binder

Specifies whether marshal, unmarshal and update methods performs validation on their XML content.

Specified by:

setSchema in class Binder<XmlNode>

Parameters:

schema - set to null to disable validation.

See Also:

Unmarshaller.setSchema(Schema)

getSchema

public Schema getSchema()

Description copied from class: Binder

Gets the last Schema object (including null) set by the Binder.setSchema(Schema) method.

Specified by:

getSchema in class Binder<XmlNode>

Returns:

the Schema object for validation or null if not present

getXMLNode

public XmlNode getXMLNode(Object jaxbObject)

Description copied from class: Binder

Gets the XML element associated with the given Jakarta XML Binding object.

Once a Jakarta XML Binding object tree is associated with an XML fragment, this method enables navigation between the two trees.

An association between an XML element and a Jakarta XML Binding object is established by the bind methods and the update methods. Note that this association is partial; not all XML elements have associated Jakarta XML Binding objects, and not all Jakarta XML Binding objects have associated XML elements.

Specified by:

getXMLNode in class Binder<XmlNode>

Parameters:

jaxbObject - An instance that is reachable from a prior call to a bind or update method that returned a Jakarta XML Binding object tree.

Returns:

null if the specified Jakarta XML Binding object is not known to this Binder, or if it is not associated with an XML element.

getJAXBNode

public Object getJAXBNode(XmlNode xmlNode)

Description copied from class: Binder

Gets the Jakarta XML Binding object associated with the given XML element.

Once a Jakarta XML Binding object tree is associated with an XML fragment, this method enables navigation between the two trees.

An association between an XML element and a Jakarta XML Binding object is established by the unmarshal, marshal and update methods. Note that this association is partial; not all XML elements have associated Jakarta XML Binding objects, and not all Jakarta XML Binding objects have associated XML elements.

Specified by:

getJAXBNode in class Binder<XmlNode>

Returns:

null if the specified XML node is not known to this Binder, or if it is not associated with a Jakarta XML Binding object.

updateXML

public XmlNode updateXML(Object jaxbObject)
                  throws JAXBException

Description copied from class: Binder

Takes an Jakarta XML Binding object and updates its associated XML node and its descendants.

This is a convenience method of:

 updateXML( jaxbObject, getXMLNode(jaxbObject));
 

Specified by:

updateXML in class Binder<XmlNode>

Throws:

JAXBException - If any unexpected problem occurs updating corresponding XML content.

updateXML

public XmlNode updateXML(Object jaxbObject,
                         XmlNode xmlNode)
                  throws JAXBException

Description copied from class: Binder

Changes in Jakarta XML Binding object tree are updated in its associated XML parse tree.

This operation can be thought of as an "in-place" marshalling. The difference is that instead of creating a whole new XML tree, this operation updates an existing tree while trying to preserve the XML as much as possible.

For example, unknown elements/attributes in XML that were not bound to Jakarta XML Binding will be left untouched (whereas a marshalling operation would create a new tree that doesn't contain any of those.)

As a side-effect, this operation updates the association between XML nodes and Jakarta XML Binding objects.

Specified by:

updateXML in class Binder<XmlNode>

Parameters:

jaxbObject - root of potentially modified Jakarta XML Binding object tree

xmlNode - root of update target XML parse tree

Returns:

Returns the updated XML node. Typically, this is the same node you passed in as xmlNode, but it maybe a different object, for example when the tag name of the object has changed.

Throws:

JAXBException - If any unexpected problem occurs updating corresponding XML content.

setEventHandler

public void setEventHandler(ValidationEventHandler handler)
                     throws JAXBException

Description copied from class: Binder

Allow an application to register a ValidationEventHandler.

The ValidationEventHandler will be called by the Jakarta XML Binding Provider if any validation errors are encountered during calls to any of the Binder unmarshal, marshal and update methods.

Calling this method with a null parameter will cause the Binder to revert back to the default default event handler.

Specified by:

setEventHandler in class Binder<XmlNode>

Parameters:

handler - the validation event handler

Throws:

JAXBException - if an error was encountered while setting the event handler

getEventHandler

public ValidationEventHandler getEventHandler()

Description copied from class: Binder

Return the current event handler or the default event handler if one hasn't been set.

Specified by:

getEventHandler in class Binder<XmlNode>

Returns:

the current ValidationEventHandler or the default event handler if it hasn't been set

setMarshallerListener

public void setMarshallerListener(Marshaller.Listener listener)

getMarshallerListener

public Marshaller.Listener getMarshallerListener()

setUnmarshallerListener

public void setUnmarshallerListener(Unmarshaller.Listener listener)

getUnmarshallerListener

public Unmarshaller.Listener getUnmarshallerListener()

getProperty

public Object getProperty(String name)
                   throws PropertyException

Description copied from class: Binder

Get the particular property in the underlying implementation of Binder. This method can only be used to get one of the standard Jakarta XML Binding defined unmarshal/marshal properties or a provider specific property for binder, unmarshal or marshal. Attempting to get an undefined property will result in a PropertyException being thrown. See Supported Unmarshal Properties and Supported Marshal Properties.

Specified by:

getProperty in class Binder<XmlNode>

Parameters:

name - the name of the property to retrieve

Returns:

the value of the requested property

Throws:

PropertyException - when there is an error retrieving the given property or value property name

setProperty

public void setProperty(String name,
                        Object value)
                 throws PropertyException

Description copied from class: Binder

Set the particular property in the underlying implementation of Binder. This method can only be used to set one of the standard Jakarta XML Binding defined unmarshal/marshal properties or a provider specific property for binder, unmarshal or marshal. Attempting to set an undefined property will result in a PropertyException being thrown. See Supported Unmarshal Properties and Supported Marshal Properties.

Specified by:

setProperty in class Binder<XmlNode>

Parameters:

name - the name of the property to be set. This value can either be specified using one of the constant fields or a user supplied string.

value - the value of the property to be set

Throws:

PropertyException - when there is an error processing the given property or value