JAXB OSGI 4.0.9 · org.glassfish.jaxb.runtime.v2.runtime.BinderImpl

Modifier and Type	Field and Description
private final AssociationMap<XmlNode>	assoc A `Binder` always works with the same association map.
private final JAXBContextImpl	context The parent context object.
private MarshallerImpl	marshaller Lazily create marshaller to do Java->XML binding.
private final InfosetScanner<XmlNode>	scanner
private UnmarshallerImpl	unmarshaller Lazily created unmarshaller to do XML->Java binding.

Access	Constructor and Description
pack-priv	BinderImpl(JAXBContextImpl _context, InfosetScanner<XmlNode> scanner)

Method Summary

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

assoc	back to summary
private final AssociationMap<XmlNode> assoc A `Binder` always works with the same association map.

context	back to summary
private final JAXBContextImpl context The parent context object.

marshaller	back to summary
private MarshallerImpl marshaller Lazily create marshaller to do Java->XML binding. See Also `getMarshaller()`

scanner	back to summary
private final InfosetScanner<XmlNode> scanner

unmarshaller	back to summary
private UnmarshallerImpl unmarshaller Lazily created unmarshaller to do XML->Java binding. See Also `getUnmarshaller()`

BinderImpl	back to summary
pack-priv BinderImpl(JAXBContextImpl _context, InfosetScanner<XmlNode> scanner)

Method Detail

associativeUnmarshal	back to summary
private Object associativeUnmarshal(XmlNode xmlNode, boolean inplace, Class<T> expectedType) throws JAXBException

createOutput	back to summary
private DOMOutput createOutput(XmlNode xmlNode)

excludeProperty	back to summary
private boolean excludeProperty(String name)

getEventHandler	back to summary
public ValidationEventHandler getEventHandler() Implements abstract jakarta.xml.bind.Binder.getEventHandler. Doc from jakarta.xml.bind.Binder.getEventHandler. Return the current event handler or the default event handler if one hasn't been set. Annotations @Override

getEventHandler

back to summary

public ValidationEventHandler getEventHandler()

Implements abstract jakarta.xml.bind.Binder.getEventHandler.

Doc from jakarta.xml.bind.Binder.getEventHandler.

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

Annotations

@Override

getJAXBNode	back to summary
public Object getJAXBNode(XmlNode xmlNode) Implements abstract jakarta.xml.bind.Binder.getJAXBNode. Doc from jakarta.xml.bind.Binder.getJAXBNode. 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. Annotations @Override

getJAXBNode

back to summary

public Object getJAXBNode(XmlNode xmlNode)

Implements abstract jakarta.xml.bind.Binder.getJAXBNode.

Doc from jakarta.xml.bind.Binder.getJAXBNode.

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.

Annotations

@Override

getMarshaller	back to summary
private MarshallerImpl getMarshaller()

getMarshallerListener	back to summary
public Marshaller.Listener getMarshallerListener()

getProperty back to summary

getProperty	back to summary
public Object getProperty(String name) throws PropertyException Implements abstract jakarta.xml.bind.Binder.getProperty. Doc from jakarta.xml.bind.Binder.getProperty. 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. Annotations @Override Exceptions PropertyException: when there is an error retrieving the given property or value property name

public Object getProperty(String name) throws PropertyException

Implements abstract jakarta.xml.bind.Binder.getProperty.

Doc from jakarta.xml.bind.Binder.getProperty.

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.

Annotations

@Override

Exceptions

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

getSchema back to summary

getSchema	back to summary
public Schema getSchema() Implements abstract jakarta.xml.bind.Binder.getSchema. Doc from jakarta.xml.bind.Binder.getSchema. Gets the last `Schema` object (including null) set by the `setSchema(Schema)` method. Annotations @Override

public Schema getSchema()

Implements abstract jakarta.xml.bind.Binder.getSchema.

Doc from jakarta.xml.bind.Binder.getSchema.

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

Annotations

@Override

getUnmarshaller	back to summary
private UnmarshallerImpl getUnmarshaller()

getUnmarshallerListener	back to summary
public Unmarshaller.Listener getUnmarshallerListener()

getXMLNode	back to summary
public XmlNode getXMLNode(Object jaxbObject) Implements abstract jakarta.xml.bind.Binder.getXMLNode. Doc from jakarta.xml.bind.Binder.getXMLNode. 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. Annotations @Override

getXMLNode

back to summary

public XmlNode getXMLNode(Object jaxbObject)

Implements abstract jakarta.xml.bind.Binder.getXMLNode.

Doc from jakarta.xml.bind.Binder.getXMLNode.

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.

Annotations

@Override

marshal back to summary

marshal	back to summary
public void marshal(Object jaxbObject, XmlNode xmlNode) throws JAXBException Implements abstract jakarta.xml.bind.Binder.marshal. Doc from jakarta.xml.bind.Binder.marshal. 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 `updateXML(Object, Object)` or `updateJAXB(Object)`. When `getSchema()` is non-null, the marshalled xml content is validated during this operation. Annotations @Override Exceptions JAXBException: If any unexpected problem occurs during the marshalling.

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

Implements abstract jakarta.xml.bind.Binder.marshal.

Doc from jakarta.xml.bind.Binder.marshal.

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 updateXML(Object, Object) or updateJAXB(Object).

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

Annotations

@Override

Exceptions

JAXBException:: If any unexpected problem occurs during the marshalling.

setEventHandler back to summary

setEventHandler	back to summary
public void setEventHandler(ValidationEventHandler handler) throws JAXBException Implements abstract jakarta.xml.bind.Binder.setEventHandler. Doc from jakarta.xml.bind.Binder.setEventHandler. 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. Annotations @Override Exceptions JAXBException: if an error was encountered while setting the event handler

public void setEventHandler(ValidationEventHandler handler) throws JAXBException

Implements abstract jakarta.xml.bind.Binder.setEventHandler.

Doc from jakarta.xml.bind.Binder.setEventHandler.

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.

Annotations

@Override

Exceptions

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

setMarshallerListener	back to summary
public void setMarshallerListener(Marshaller.Listener listener)

setProperty back to summary

setProperty	back to summary
public void setProperty(String name, Object value) throws PropertyException Implements abstract jakarta.xml.bind.Binder.setProperty. Doc from jakarta.xml.bind.Binder.setProperty. 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. Annotations @Override Exceptions PropertyException: when there is an error processing the given property or value

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

Implements abstract jakarta.xml.bind.Binder.setProperty.

Doc from jakarta.xml.bind.Binder.setProperty.

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.

Annotations

@Override

Exceptions

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

setSchema	back to summary
public void setSchema(Schema schema) Implements abstract jakarta.xml.bind.Binder.setSchema. Doc from jakarta.xml.bind.Binder.setSchema. Specifies whether marshal, unmarshal and update methods performs validation on their XML content. Annotations @Override

setSchema

back to summary

public void setSchema(Schema schema)

Implements abstract jakarta.xml.bind.Binder.setSchema.

Doc from jakarta.xml.bind.Binder.setSchema.

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

Annotations

@Override

setUnmarshallerListener	back to summary
public void setUnmarshallerListener(Unmarshaller.Listener listener)

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(XmlNode xmlNode) throws JAXBException Implements abstract jakarta.xml.bind.Binder.unmarshal. Doc from jakarta.xml.bind.Binder.unmarshal. 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, `updateXML(Object, Object)` or `updateJAXB(Object)`. When `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 `unmarshal(Object, Class)` enables an application to specify the Jakarta XML Binding mapped class that the `xmlNode` should be mapped to. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

public Object unmarshal(XmlNode xmlNode) throws JAXBException

Implements abstract jakarta.xml.bind.Binder.unmarshal.

Doc from jakarta.xml.bind.Binder.unmarshal.

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, updateXML(Object, Object) or updateJAXB(Object).

When 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 unmarshal(Object, Class) enables an application to specify the Jakarta XML Binding mapped class that the xmlNode should be mapped to.

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(XmlNode xmlNode, Class<T> expectedType) throws JAXBException Implements abstract jakarta.xml.bind.Binder.unmarshal. Doc from jakarta.xml.bind.Binder.unmarshal. 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, `updateXML(Object, Object)` or `updateJAXB(Object)`. When `getSchema()` is non-null, `xmlNode` and its descendants is validated during this operation. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

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

Implements abstract jakarta.xml.bind.Binder.unmarshal.

Doc from jakarta.xml.bind.Binder.unmarshal.

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, updateXML(Object, Object) or updateJAXB(Object).

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

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

updateJAXB	back to summary
public Object updateJAXB(XmlNode xmlNode) throws JAXBException Implements abstract jakarta.xml.bind.Binder.updateJAXB. Doc from jakarta.xml.bind.Binder.updateJAXB. 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. Annotations @Override Exceptions JAXBException: If any unexpected problem occurs updating corresponding Jakarta XML Binding mapped content.

updateJAXB

back to summary

public Object updateJAXB(XmlNode xmlNode) throws JAXBException

Implements abstract jakarta.xml.bind.Binder.updateJAXB.

Doc from jakarta.xml.bind.Binder.updateJAXB.

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.

Annotations

@Override

Exceptions

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

updateXML	back to summary
public XmlNode updateXML(Object jaxbObject) throws JAXBException Implements abstract jakarta.xml.bind.Binder.updateXML. Doc from jakarta.xml.bind.Binder.updateXML. 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)); Annotations @Override Exceptions JAXBException: If any unexpected problem occurs updating corresponding XML content.

updateXML

back to summary

public XmlNode updateXML(Object jaxbObject) throws JAXBException

Implements abstract jakarta.xml.bind.Binder.updateXML.

Doc from jakarta.xml.bind.Binder.updateXML.

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));

Annotations

@Override

Exceptions

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

updateXML	back to summary
public XmlNode updateXML(Object jaxbObject, XmlNode xmlNode) throws JAXBException Implements abstract jakarta.xml.bind.Binder.updateXML. Doc from jakarta.xml.bind.Binder.updateXML. 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. Annotations @Override @SuppressWarnings:unchecked Exceptions JAXBException: If any unexpected problem occurs updating corresponding XML content.

updateXML

back to summary

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

Implements abstract jakarta.xml.bind.Binder.updateXML.

Doc from jakarta.xml.bind.Binder.updateXML.

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.

Annotations

@Override
@SuppressWarnings:unchecked

Exceptions

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

public Class BinderImpl<XmlNode>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail