|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.bind.Binder
org.eclipse.persistence.jaxb.JAXBBinder
public class JAXBBinder
INTERNAL
Purpose: Provide a TopLink implementation of the javax.xml.bind.Binder interface
Responsibilities:
Binder
Constructor Summary | |
---|---|
JAXBBinder(XMLContext xmlContext)
|
Method Summary | |
---|---|
ValidationEventHandler |
getEventHandler()
Return the current event handler or the default event handler if one hasn't been set. |
java.lang.Object |
getJAXBNode(java.lang.Object obj)
Gets the JAXB object associated with the given XML element. |
java.lang.Object |
getProperty(java.lang.String propName)
Get the particular property in the underlying implementation of Binder. |
javax.xml.validation.Schema |
getSchema()
Gets the last Schema object (including null) set by the
Binder.setSchema(Schema) method. |
XMLBinder |
getXMLBinder()
|
java.lang.Object |
getXMLNode(java.lang.Object obj)
Gets the XML element associated with the given JAXB object. |
void |
marshal(java.lang.Object obj,
java.lang.Object xmlNode)
Marshal a JAXB object tree to a new XML document. |
void |
setEventHandler(ValidationEventHandler newValidationEventHandler)
Allow an application to register a ValidationEventHandler. |
void |
setProperty(java.lang.String propName,
java.lang.Object value)
Set the particular property in the underlying implementation of Binder. |
void |
setSchema(javax.xml.validation.Schema schema)
Specifies whether marshal, unmarshal and update methods performs validation on their XML content. |
java.lang.Object |
unmarshal(java.lang.Object obj)
Unmarshal XML infoset view to a JAXB object tree. |
JAXBElement |
unmarshal(java.lang.Object obj,
java.lang.Class javaClass)
Unmarshal XML root element by provided declaredType to a JAXB object tree. |
java.lang.Object |
updateJAXB(java.lang.Object obj)
Takes an XML node and updates its associated JAXB object and its descendants. |
java.lang.Object |
updateXML(java.lang.Object obj)
Takes an JAXB object and updates its associated XML node and its descendants. |
java.lang.Object |
updateXML(java.lang.Object obj,
java.lang.Object xmlNode)
Changes in JAXB 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 |
Constructor Detail |
---|
public JAXBBinder(XMLContext xmlContext)
Method Detail |
---|
public void marshal(java.lang.Object obj, java.lang.Object xmlNode) throws MarshalException
Binder
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 as
Binder.updateXML(Object, Object)
or Binder.updateJAXB(Object)
.
When Binder.getSchema()
is non-null, the marshalled
xml content is validated during this operation.
marshal
in class Binder
obj
- The content tree to be marshalled.xmlNode
- The parameter must be a Node that accepts children.
MarshalException
- If the ValidationEventHandler
returns false from its handleEvent method or the
Binder is unable to marshal jaxbObject (or any
object reachable from jaxbObject).public java.lang.Object unmarshal(java.lang.Object obj) throws JAXBException
Binder
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)
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 JAXB mapped class. The method Binder.unmarshal(Object, Class)
enables an application to specify the JAXB mapped class that
the xmlNode should be mapped to.
unmarshal
in class Binder
obj
- the document/element to unmarshal XML data from.
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.public JAXBElement unmarshal(java.lang.Object obj, java.lang.Class javaClass) throws JAXBException
Binder
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)
or Binder.updateJAXB(Object)
.
When Binder.getSchema()
is non-null, xmlNode
and its descendants is validated during this operation.
unmarshal
in class Binder
obj
- the document/element to unmarshal XML data from.javaClass
- appropriate JAXB mapped class to hold node's XML data.
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.public java.lang.Object getXMLNode(java.lang.Object obj)
Binder
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.
getXMLNode
in class Binder
obj
- An instance that is reachable from a prior
call to a bind or update method that returned
a JAXB object tree.
Binder
, or if it is not associated with an
XML element.public java.lang.Object updateXML(java.lang.Object obj)
Binder
This is a convenience method of:
updateXML( jaxbObject, getXMLNode(jaxbObject));
updateXML
in class Binder
public java.lang.Object updateXML(java.lang.Object obj, java.lang.Object xmlNode)
Binder
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.
updateXML
in class Binder
obj
- root of potentially modified JAXB object treexmlNode
- root of update target XML parse tree
public java.lang.Object getJAXBNode(java.lang.Object obj)
Binder
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.
getJAXBNode
in class Binder
Binder
, or if it is not associated with a
JAXB object.public java.lang.Object updateJAXB(java.lang.Object obj) throws JAXBException
Binder
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.
updateJAXB
in class Binder
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.
JAXBException
- If any unexpected problem occurs updating corresponding JAXB mapped content.public void setSchema(javax.xml.validation.Schema schema)
Binder
setSchema
in class Binder
schema
- set to null to disable validation.Unmarshaller.setSchema(Schema)
public javax.xml.validation.Schema getSchema()
Binder
Schema
object (including null) set by the
Binder.setSchema(Schema)
method.
getSchema
in class Binder
public void setEventHandler(ValidationEventHandler newValidationEventHandler) throws JAXBException
Binder
The ValidationEventHandler will 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.
setEventHandler
in class Binder
newValidationEventHandler
- the validation event handler
JAXBException
- if an error was encountered while setting the
event handlerpublic ValidationEventHandler getEventHandler()
Binder
getEventHandler
in class Binder
public java.lang.Object getProperty(java.lang.String propName) throws PropertyException
Binder
getProperty
in class Binder
propName
- the name of the property to retrieve
PropertyException
- when there is an error retrieving the given property or value
property namepublic void setProperty(java.lang.String propName, java.lang.Object value) throws PropertyException
Binder
setProperty
in class Binder
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
PropertyException
- when there is an error processing the given
property or valuepublic XMLBinder getXMLBinder()
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |