|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.xml.bind.helpers.AbstractMarshallerImpl
Partial default Marshaller implementation.
This class provides a partial default implementation for the
Marshaller
interface.
The only method that a JAXB Provider has to implement is
marshal(Object, javax.xml.transform.Result)
.
Marshaller
Field Summary |
Fields inherited from interface javax.xml.bind.Marshaller |
JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION |
Constructor Summary | |
AbstractMarshallerImpl()
|
Method Summary | |
protected java.lang.String |
getEncoding()
Convenience method for getting the current output encoding. |
ValidationEventHandler |
getEventHandler()
Return the current event handler or the default event handler if one hasn't been set. |
protected java.lang.String |
getJavaEncoding(java.lang.String encoding)
Gets the corresponding Java encoding name from an IANA name. |
Node |
getNode(java.lang.Object obj)
By default, the getNode method is unsupported and throw an UnsupportedOperationException . |
protected java.lang.String |
getNoNSSchemaLocation()
Convenience method for getting the current noNamespaceSchemaLocation. |
java.lang.Object |
getProperty(java.lang.String name)
Default implementation of the getProperty method handles the four defined properties in Marshaller. |
protected java.lang.String |
getSchemaLocation()
Convenience method for getting the current schemaLocation. |
protected boolean |
isFormattedOutput()
Convenience method for getting the formatted output flag. |
void |
marshal(java.lang.Object obj,
ContentHandler handler)
Marshal the content tree rooted at obj into SAX2 events. |
void |
marshal(java.lang.Object obj,
Node node)
Marshal the content tree rooted at obj into a DOM tree. |
void |
marshal(java.lang.Object obj,
java.io.OutputStream os)
Marshal the content tree rooted at obj into an output stream. |
void |
marshal(java.lang.Object obj,
java.io.Writer w)
Marshal the content tree rooted at obj into a Writer. |
protected void |
setEncoding(java.lang.String encoding)
Convenience method for setting the output encoding. |
void |
setEventHandler(ValidationEventHandler handler)
Allow an application to register a validation event handler. |
protected void |
setFormattedOutput(boolean v)
Convenience method for setting the formatted output flag. |
protected void |
setNoNSSchemaLocation(java.lang.String location)
Convenience method for setting the noNamespaceSchemaLocation. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Default implementation of the setProperty method handles the four defined properties in Marshaller. |
protected void |
setSchemaLocation(java.lang.String location)
Convenience method for setting the schemaLocation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.xml.bind.Marshaller |
marshal |
Constructor Detail |
public AbstractMarshallerImpl()
Method Detail |
public final void marshal(java.lang.Object obj, java.io.OutputStream os) throws JAXBException
Marshaller
marshal
in interface Marshaller
obj
- The content tree to be marshalled.os
- XML will be added to this stream.
JAXBException
- If any unexpected problem occurs during the marshalling.public final void marshal(java.lang.Object obj, java.io.Writer w) throws JAXBException
Marshaller
marshal
in interface Marshaller
obj
- The content tree to be marshalled.w
- XML will be sent to this writer.
JAXBException
- If any unexpected problem occurs during the marshalling.public final void marshal(java.lang.Object obj, ContentHandler handler) throws JAXBException
Marshaller
marshal
in interface Marshaller
obj
- The content tree to be marshalled.handler
- XML will be sent to this handler as SAX2 events.
JAXBException
- If any unexpected problem occurs during the marshalling.public final void marshal(java.lang.Object obj, Node node) throws JAXBException
Marshaller
marshal
in interface Marshaller
obj
- The content tree to be marshalled.node
- DOM nodes will be added as children of this node.
This parameter must be a Node that accepts children
(Document
,
DocumentFragment
, or
Element
)
JAXBException
- If any unexpected problem occurs during the marshalling.public Node getNode(java.lang.Object obj) throws JAXBException
UnsupportedOperationException
.
Implementations that choose to support this method must
override this method.
getNode
in interface Marshaller
obj
- - JAXB Java representation of XML content
JAXBException
- If any unexpected problem occursprotected java.lang.String getEncoding()
protected void setEncoding(java.lang.String encoding)
encoding
- a valid encoding as specified in the Marshaller class
documentationprotected java.lang.String getSchemaLocation()
protected void setSchemaLocation(java.lang.String location)
location
- the schemaLocation valueprotected java.lang.String getNoNSSchemaLocation()
protected void setNoNSSchemaLocation(java.lang.String location)
location
- the noNamespaceSchemaLocation valueprotected boolean isFormattedOutput()
protected void setFormattedOutput(boolean v)
v
- value of the formatted output flag.protected java.lang.String getJavaEncoding(java.lang.String encoding) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
- If this implementation couldn't find the Java encoding name.public void setProperty(java.lang.String name, java.lang.Object value) throws PropertyException
setProperty
in interface Marshaller
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
PropertyException
- when there is an error processing the given
property or valuepublic java.lang.Object getProperty(java.lang.String name) throws PropertyException
getProperty
in interface Marshaller
name
- the name of the property to retrieve
PropertyException
- when there is an error retrieving the given property or value
property namepublic ValidationEventHandler getEventHandler() throws JAXBException
Marshaller
getEventHandler
in interface Marshaller
JAXBException
- if an error was encountered while getting the
current event handlerMarshaller.getEventHandler()
public void setEventHandler(ValidationEventHandler handler) throws JAXBException
Marshaller
The validation event handler will be called by the JAXB Provider if any validation errors are encountered during calls to any of the marshal API's. If the client application does not register a validation event handler before invoking one of the marshal methods, then validation events will be handled by the default event handler which will terminate the marshal operation after the first error or fatal error is encountered.
Calling this method with a null parameter will cause the Marshaller to revert back to the default vefault event handler.
setEventHandler
in interface Marshaller
handler
- the validation event handler
JAXBException
- if an error was encountered while setting the
event handlerMarshaller.setEventHandler(ValidationEventHandler)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |