Class JAXBBinder
- java.lang.Object
-
- javax.xml.bind.Binder
-
- org.eclipse.persistence.jaxb.JAXBBinder
-
-
Constructor Summary
Constructors Constructor Description JAXBBinder(JAXBContext xmlContext, XMLMarshaller marshaller, XMLUnmarshaller unmarshaller)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ValidationEventHandlergetEventHandler()Return the current event handler or the default event handler if one hasn't been set.java.lang.ObjectgetJAXBNode(java.lang.Object obj)Gets the JAXB object associated with the given XML element.java.lang.ObjectgetProperty(java.lang.String propName)Get the particular property in the underlying implementation ofBinder.javax.xml.validation.SchemagetSchema()Gets the lastSchemaobject (including null) set by theBinder.setSchema(Schema)method.XMLBindergetXMLBinder()java.lang.ObjectgetXMLNode(java.lang.Object obj)Gets the XML element associated with the given JAXB object.voidmarshal(java.lang.Object obj, java.lang.Object xmlNode)Marshal a JAXB object tree to a new XML document.voidsetEventHandler(ValidationEventHandler newValidationEventHandler)Allow an application to register aValidationEventHandler.voidsetProperty(java.lang.String propName, java.lang.Object value)Set the particular property in the underlying implementation ofBinder.voidsetSchema(javax.xml.validation.Schema schema)Specifies whether marshal, unmarshal and update methods performs validation on their XML content.java.lang.Objectunmarshal(java.lang.Object obj)Unmarshal XML infoset view to a JAXB object tree.JAXBElementunmarshal(java.lang.Object obj, java.lang.Class javaClass)Unmarshal XML root element by provideddeclaredTypeto a JAXB object tree.java.lang.ObjectupdateJAXB(java.lang.Object obj)Takes an XML node and updates its associated JAXB object and its descendants.java.lang.ObjectupdateXML(java.lang.Object obj)Takes an JAXB object and updates its associated XML node and its descendants.java.lang.ObjectupdateXML(java.lang.Object obj, java.lang.Object xmlNode)Changes in JAXB object tree are updated in its associated XML parse tree.
-
-
-
Constructor Detail
-
JAXBBinder
public JAXBBinder(JAXBContext xmlContext, XMLMarshaller marshaller, XMLUnmarshaller unmarshaller)
-
-
Method Detail
-
marshal
public void marshal(java.lang.Object obj, java.lang.Object xmlNode) throws MarshalExceptionDescription copied from class:BinderMarshal a JAXB object tree to a new XML document.This method is similar to
Marshaller.marshal(Object, Node)with the addition of maintaining the association between JAXB objects and the produced XML nodes, enabling future update operations such asBinder.updateXML(Object, Object)orBinder.updateJAXB(Object).When
Binder.getSchema()is non-null, the marshalled xml content is validated during this operation.- Specified by:
marshalin classBinder- Parameters:
obj- The content tree to be marshalled.xmlNode- The parameter must be a Node that accepts children.- Throws:
MarshalException- If theValidationEventHandlerreturns false from itshandleEventmethod or theBinderis unable to marshaljaxbObject(or any object reachable fromjaxbObject).
-
unmarshal
public java.lang.Object unmarshal(java.lang.Object obj) throws JAXBExceptionDescription copied from class:BinderUnmarshal XML infoset view to a JAXB object tree.This method is similar to
Unmarshaller.unmarshal(Node)with the addition of maintaining the association between XML nodes and the produced JAXB objects, enabling future update operations,Binder.updateXML(Object, Object)orBinder.updateJAXB(Object).When
Binder.getSchema()is non-null,xmlNodeand its descendants is validated during this operation.This method throws
UnmarshalExceptionwhen the Binder'sJAXBContextdoes not have a mapping for the XML element name or the type, specifiable via@xsi:type, ofxmlNodeto a JAXB mapped class. The methodBinder.unmarshal(Object, Class)enables an application to specify the JAXB mapped class that thexmlNodeshould be mapped to.- Specified by:
unmarshalin classBinder- Parameters:
obj- the document/element to unmarshal XML data from.- Returns:
- the newly created root object of the JAXB object tree.
- Throws:
JAXBException- If any unexpected errors occur while unmarshallingUnmarshalException- If theValidationEventHandlerreturns false from itshandleEventmethod or theBinderis unable to perform the XML to Java binding.
-
unmarshal
public JAXBElement unmarshal(java.lang.Object obj, java.lang.Class javaClass) throws JAXBException
Description copied from class:BinderUnmarshal XML root element by provideddeclaredTypeto a JAXB 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 JAXB objects, enabling future update operations,Binder.updateXML(Object, Object)orBinder.updateJAXB(Object).When
Binder.getSchema()is non-null,xmlNodeand its descendants is validated during this operation.- Specified by:
unmarshalin classBinder- Parameters:
obj- the document/element to unmarshal XML data from.javaClass- appropriate JAXB mapped class to holdnode's XML data.- Returns:
- JAXB Element representation
of
node - Throws:
JAXBException- If any unexpected errors occur while unmarshallingUnmarshalException- If theValidationEventHandlerreturns false from itshandleEventmethod or theBinderis unable to perform the XML to Java binding.
-
getXMLNode
public java.lang.Object getXMLNode(java.lang.Object obj)
Description copied from class:BinderGets the XML element associated with the given JAXB object.Once a JAXB object tree is associated with an XML fragment, this method enables navigation between the two trees.
An association between an XML element and a JAXB object is established by the bind methods and the update methods. Note that this association is partial; not all XML elements have associated JAXB objects, and not all JAXB objects have associated XML elements.
- Specified by:
getXMLNodein classBinder- Parameters:
obj- An instance that is reachable from a prior call to a bind or update method that returned a JAXB object tree.- Returns:
- null if the specified JAXB object is not known to this
Binder, or if it is not associated with an XML element.
-
updateXML
public java.lang.Object updateXML(java.lang.Object obj)
Description copied from class:BinderTakes an JAXB object and updates its associated XML node and its descendants.This is a convenience method of:
updateXML( jaxbObject, getXMLNode(jaxbObject));
-
updateXML
public java.lang.Object updateXML(java.lang.Object obj, java.lang.Object xmlNode)Description copied from class:BinderChanges in JAXB 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 JAXB 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 JAXB objects.
- Specified by:
updateXMLin classBinder- Parameters:
obj- root of potentially modified JAXB object treexmlNode- 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.
-
getJAXBNode
public java.lang.Object getJAXBNode(java.lang.Object obj)
Description copied from class:BinderGets the JAXB object associated with the given XML element.Once a JAXB object tree is associated with an XML fragment, this method enables navigation between the two trees.
An association between an XML element and a JAXB object is established by the unmarshal, marshal and update methods. Note that this association is partial; not all XML elements have associated JAXB objects, and not all JAXB objects have associated XML elements.
- Specified by:
getJAXBNodein classBinder- Returns:
- null if the specified XML node is not known to this
Binder, or if it is not associated with a JAXB object.
-
updateJAXB
public java.lang.Object updateJAXB(java.lang.Object obj) throws JAXBExceptionDescription copied from class:BinderTakes an XML node and updates its associated JAXB 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 JAXB tree, this operation updates an existing tree, reusing as much JAXB objects as possible.
As a side-effect, this operation updates the association between XML nodes and JAXB objects.
- Specified by:
updateJAXBin classBinder- Returns:
- Returns the updated JAXB object. Typically, this is the same
object that was returned from earlier
Binder.marshal(Object,Object)orBinder.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 JAXB mapped content.
-
setSchema
public void setSchema(javax.xml.validation.Schema schema)
Description copied from class:BinderSpecifies whether marshal, unmarshal and update methods performs validation on their XML content.- Specified by:
setSchemain classBinder- Parameters:
schema- set to null to disable validation.- See Also:
Unmarshaller.setSchema(Schema)
-
getSchema
public javax.xml.validation.Schema getSchema()
Description copied from class:BinderGets the lastSchemaobject (including null) set by theBinder.setSchema(Schema)method.
-
setEventHandler
public void setEventHandler(ValidationEventHandler newValidationEventHandler) throws JAXBException
Description copied from class:BinderAllow an application to register aValidationEventHandler.The
ValidationEventHandlerwill be called by the JAXB 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:
setEventHandlerin classBinder- Parameters:
newValidationEventHandler- the validation event handler- Throws:
JAXBException- if an error was encountered while setting the event handler
-
getEventHandler
public ValidationEventHandler getEventHandler()
Description copied from class:BinderReturn the current event handler or the default event handler if one hasn't been set.- Specified by:
getEventHandlerin classBinder- Returns:
- the current ValidationEventHandler or the default event handler if it hasn't been set
-
getProperty
public java.lang.Object getProperty(java.lang.String propName) throws PropertyExceptionDescription copied from class:BinderGet the particular property in the underlying implementation ofBinder. This method can only be used to get one of the standard JAXB 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:
getPropertyin classBinder- Parameters:
propName- 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(java.lang.String propName, java.lang.Object value) throws PropertyExceptionDescription copied from class:BinderSet the particular property in the underlying implementation ofBinder. This method can only be used to set one of the standard JAXB 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:
setPropertyin classBinder- Parameters:
propName- 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
-
getXMLBinder
public XMLBinder getXMLBinder()
-
-