javax.xml.bind.util: public class: JAXBResult

javax.xml.bind.util
public class: JAXBResult [javadoc | source]

java.lang.Object
   javax.xml.transform.sax.SAXResult
      javax.xml.bind.util.JAXBResult

All Implemented Interfaces:
Result

JAXP javax.xml.transform.Result implementation that unmarshals a JAXB object.

This utility class is useful to combine JAXB with other Java/XML technologies.

The following example shows how to use JAXB to unmarshal a document resulting from an XSLT transformation.

JAXBResult result = new JAXBResult(
JAXBContext.newInstance("org.acme.foo") );

// set up XSLT transformation
TransformerFactory tf = TransformerFactory.newInstance();
Transformer t = tf.newTransformer(new StreamSource("test.xsl"));

// run transformation
t.transform(new StreamSource("document.xml"),result);

// obtain the unmarshalled content tree
Object o = result.getResult();

The fact that JAXBResult derives from SAXResult is an implementation detail. Thus in general applications are strongly discouraged from accessing methods defined on SAXResult.

In particular it shall never attempt to call the setHandler, setLexicalHandler, and setSystemId methods.

author: Kohsuke - Kawaguchi (kohsuke.kawaguchi@sun.com)

Fields inherited from javax.xml.transform.sax.SAXResult:
FEATURE

Constructor:

Constructor:
public JAXBResult(JAXBContext context) throws JAXBException { this( ( context == null ) ? assertionFailed() : context.createUnmarshaller() ); } Creates a new instance that uses the specified JAXBContext to unmarshal. Parameters: `context` - The JAXBContext that will be used to create the necessary Unmarshaller. This parameter must not be null. Throws: `JAXBException` - if an error is encountered while creating the JAXBResult or if the context parameter is null. exception: `JAXBException` - if an error is encountered while creating the JAXBResult or if the context parameter is null.
public JAXBResult(Unmarshaller _unmarshaller) throws JAXBException { if( _unmarshaller == null ) throw new JAXBException( Messages.format( Messages.RESULT_NULL_UNMARSHALLER ) ); this.unmarshallerHandler = _unmarshaller.getUnmarshallerHandler(); super.setHandler(unmarshallerHandler); } Creates a new instance that uses the specified Unmarshaller to unmarshal an object. This JAXBResult object will use the specified Unmarshaller instance. It is the caller's responsibility not to use the same Unmarshaller for other purposes while it is being used by this object. The primary purpose of this method is to allow the client to configure Unmarshaller. Unless you know what you are doing, it's easier and safer to pass a JAXBContext. Parameters: `_unmarshaller` - the unmarshaller. This parameter must not be null. Throws: `JAXBException` - if an error is encountered while creating the JAXBResult or the Unmarshaller parameter is null.

 public JAXBResult(JAXBContext context) throws JAXBException {
        this( ( context == null ) ? assertionFailed() : context.createUnmarshaller() );
}

Creates a new instance that uses the specified JAXBContext to unmarshal.

Parameters:

context - The JAXBContext that will be used to create the necessary Unmarshaller. This parameter must not be null.

Throws:

JAXBException - if an error is encountered while creating the JAXBResult or if the context parameter is null.

exception: JAXBException - if an error is encountered while creating the JAXBResult or if the context parameter is null.

 public JAXBResult(Unmarshaller _unmarshaller) throws JAXBException {
        if( _unmarshaller == null )
            throw new JAXBException(
                Messages.format( Messages.RESULT_NULL_UNMARSHALLER ) );
        this.unmarshallerHandler = _unmarshaller.getUnmarshallerHandler();
        super.setHandler(unmarshallerHandler);
}

This JAXBResult object will use the specified Unmarshaller instance. It is the caller's responsibility not to use the same Unmarshaller for other purposes while it is being used by this object.

The primary purpose of this method is to allow the client to configure Unmarshaller. Unless you know what you are doing, it's easier and safer to pass a JAXBContext.

Parameters:

_unmarshaller - the unmarshaller. This parameter must not be null.

Throws:

JAXBException - if an error is encountered while creating the JAXBResult or the Unmarshaller parameter is null.

Method from javax.xml.bind.util.JAXBResult Summary:
getResult

Methods from javax.xml.transform.sax.SAXResult:
getHandler, getLexicalHandler, getSystemId, setHandler, setLexicalHandler, setSystemId

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

Method from javax.xml.bind.util.JAXBResult Detail:
public Object getResult() throws JAXBException { return unmarshallerHandler.getResult(); } Gets the unmarshalled object created by the transformation.

Method from javax.xml.bind.util.JAXBResult Detail:

 public Object getResult() throws JAXBException {
        return unmarshallerHandler.getResult();
}

Gets the unmarshalled object created by the transformation.