Jakarta XML Binding API 4.0.0 · jakarta.xml.bind.annotation.W3CDomHandler

Modifier and Type	Field and Description
private DocumentBuilder	builder

Access	Constructor and Description
public	W3CDomHandler() Default constructor.
public	W3CDomHandler(DocumentBuilder must not be null. Jakarta XML Binding uses this `DocumentBuilder` to create a new element. builder) Constructor that allows applications to specify which DOM implementation to be used.

Method Summary

Modifier and Type	Method and Description
public DOMResult	createUnmarshaller(ValidationEventHandler if any error happens between the invocation of this method and the invocation of `getElement(Result)`, they must be reported to this handler. The caller must provide a non-null error handler. The `Result` object created from this method may hold a reference to this error handler. errorHandler) Implements jakarta.xml.bind.annotation.DomHandler.createUnmarshaller. When a Jakarta XML Binding provider needs to unmarshal a part of a document into an infoset representation, it first calls this method to create a `Result` object.
public DocumentBuilder	getBuilder()
public Element	getElement(DOMResult The `Result` object created by `createUnmarshaller(ValidationEventHandler)`. r) Implements jakarta.xml.bind.annotation.DomHandler.getElement. Once the portion is sent to the `Result`.
public Source	marshal(Element element, ValidationEventHandler Receives any errors happened during the process of converting an element into a `Source`. The caller must provide a non-null error handler. errorHandler) Implements jakarta.xml.bind.annotation.DomHandler.marshal. This method is called when a Jakarta XML Binding provider needs to marshal an element to XML.
public void	setBuilder(DocumentBuilder builder)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

builder	back to summary
private DocumentBuilder builder

W3CDomHandler	back to summary
public W3CDomHandler() Default constructor. It is up to a Jakarta XML Binding provider to decide which DOM implementation to use or how that is configured.

W3CDomHandler	back to summary
public W3CDomHandler(DocumentBuilder builder) Constructor that allows applications to specify which DOM implementation to be used. Parameters builder:DocumentBuilder must not be null. Jakarta XML Binding uses this `DocumentBuilder` to create a new element.

Method Detail

createUnmarshaller back to summary

createUnmarshaller	back to summary
public DOMResult createUnmarshaller(ValidationEventHandler errorHandler) Implements jakarta.xml.bind.annotation.DomHandler.createUnmarshaller. Doc from jakarta.xml.bind.annotation.DomHandler.createUnmarshaller. When a Jakarta XML Binding provider needs to unmarshal a part of a document into an infoset representation, it first calls this method to create a `Result` object. A Jakarta XML Binding provider will then send a portion of the XML into the given result. Such a portion always form a subtree of the whole XML document rooted at an element. Parameters errorHandler:ValidationEventHandler if any error happens between the invocation of this method and the invocation of `getElement(Result)`, they must be reported to this handler. The caller must provide a non-null error handler. The `Result` object created from this method may hold a reference to this error handler. Returns:DOMResult null if the operation fails. The error must have been reported to the error handler. Annotations @Override

public DOMResult createUnmarshaller(ValidationEventHandler errorHandler)

Implements jakarta.xml.bind.annotation.DomHandler.createUnmarshaller.

Doc from jakarta.xml.bind.annotation.DomHandler.createUnmarshaller.

When a Jakarta XML Binding provider needs to unmarshal a part of a document into an infoset representation, it first calls this method to create a Result object.

A Jakarta XML Binding provider will then send a portion of the XML into the given result. Such a portion always form a subtree of the whole XML document rooted at an element.

Parameters

errorHandler:ValidationEventHandler: if any error happens between the invocation of this method and the invocation of getElement(Result), they must be reported to this handler. The caller must provide a non-null error handler. The Result object created from this method may hold a reference to this error handler.

Returns:DOMResult

null if the operation fails. The error must have been reported to the error handler.

Annotations

@Override

getBuilder	back to summary
public DocumentBuilder getBuilder()

getElement back to summary

getElement	back to summary
public Element getElement(DOMResult r) Implements jakarta.xml.bind.annotation.DomHandler.getElement. Doc from jakarta.xml.bind.annotation.DomHandler.getElement. Once the portion is sent to the `Result`. This method is called by a Jakarta XML Binding provider to obtain the unmarshalled element representation. Multiple invocations of this method may return different objects. This method can be invoked only when the whole sub-tree are fed to the `Result` object. Parameters r:DOMResult The `Result` object created by `createUnmarshaller(ValidationEventHandler)`. Returns:Element null if the operation fails. The error must have been reported to the error handler. Annotations @Override

public Element getElement(DOMResult r)

Implements jakarta.xml.bind.annotation.DomHandler.getElement.

Doc from jakarta.xml.bind.annotation.DomHandler.getElement.

Once the portion is sent to the Result. This method is called by a Jakarta XML Binding provider to obtain the unmarshalled element representation.

Multiple invocations of this method may return different objects. This method can be invoked only when the whole sub-tree are fed to the Result object.

Parameters

r:DOMResult: The Result object created by createUnmarshaller(ValidationEventHandler).

Returns:Element

null if the operation fails. The error must have been reported to the error handler.

Annotations

@Override

marshal back to summary

marshal	back to summary
public Source marshal(Element element, ValidationEventHandler errorHandler) Implements jakarta.xml.bind.annotation.DomHandler.marshal. Doc from jakarta.xml.bind.annotation.DomHandler.marshal. This method is called when a Jakarta XML Binding provider needs to marshal an element to XML. If non-null, the returned `Source` must contain a whole document rooted at one element, which will then be weaved into a bigger document that the Jakarta XML Binding provider is marshalling. Parameters errorHandler:ValidationEventHandler Receives any errors happened during the process of converting an element into a `Source`. The caller must provide a non-null error handler. Returns:Source null if there was an error. The error should have been reported to the handler. Annotations @Override

public Source marshal(Element element, ValidationEventHandler errorHandler)

Implements jakarta.xml.bind.annotation.DomHandler.marshal.

Doc from jakarta.xml.bind.annotation.DomHandler.marshal.

This method is called when a Jakarta XML Binding provider needs to marshal an element to XML.

If non-null, the returned Source must contain a whole document rooted at one element, which will then be weaved into a bigger document that the Jakarta XML Binding provider is marshalling.

Parameters

errorHandler:ValidationEventHandler: Receives any errors happened during the process of converting an element into a Source. The caller must provide a non-null error handler.

Returns:Source

null if there was an error. The error should have been reported to the handler.

Annotations

@Override

setBuilder	back to summary
public void setBuilder(DocumentBuilder builder)

public Class W3CDomHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail