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

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

java.lang.Object
   javax.xml.transform.sax.SAXSource
      javax.xml.bind.util.JAXBSource

All Implemented Interfaces:
Source

JAXP javax.xml.transform.Source implementation that marshals a JAXB-generated object.

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

The following example shows how to use JAXB to marshal a document for transformation by XSLT.

MyObject o = // get JAXB content tree

// jaxbContext is a JAXBContext object from which 'o' is created.
JAXBSource source = new JAXBSource( jaxbContext, o );

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

// run transformation
t.transform(source,new StreamResult(System.out));

The fact that JAXBSource derives from SAXSource is an implementation detail. Thus in general applications are strongly discouraged from accessing methods defined on SAXSource. In particular, the setXMLReader and setInputSource methods shall never be called. The XMLReader object obtained by the getXMLReader method shall be used only for parsing the InputSource object returned by the getInputSource method.

Similarly the InputSource object obtained by the getInputSource method shall be used only for being parsed by the XMLReader object returned by the getXMLReader.

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

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

Constructor:

Constructor:
public JAXBSource(JAXBContext context, Object contentObject) throws JAXBException { this( ( context == null ) ? assertionFailed( Messages.format( Messages.SOURCE_NULL_CONTEXT ) ) : context.createMarshaller(), ( contentObject == null ) ? assertionFailed( Messages.format( Messages.SOURCE_NULL_CONTENT ) ) : contentObject); } Creates a new javax.xml.transform.Source for the given content object. Parameters: `context` - JAXBContext that was used to create `contentObject`. This context is used to create a new instance of marshaller and must not be null. `contentObject` - An instance of a JAXB-generated class, which will be used as a javax.xml.transform.Source (by marshalling it into XML). It must not be null. Throws: `JAXBException` - if an error is encountered while creating the JAXBSource or if either of the parameters are null.
public JAXBSource(Marshaller marshaller, Object contentObject) throws JAXBException { if( marshaller == null ) throw new JAXBException( Messages.format( Messages.SOURCE_NULL_MARSHALLER ) ); if( contentObject == null ) throw new JAXBException( Messages.format( Messages.SOURCE_NULL_CONTENT ) ); this.marshaller = marshaller; this.contentObject = contentObject; super.setXMLReader(pseudoParser); // pass a dummy InputSource. We don't care super.setInputSource(new InputSource()); } Creates a new javax.xml.transform.Source for the given content object. Parameters: `marshaller` - A marshaller instance that will be used to marshal `contentObject` into XML. This must be created from a JAXBContext that was used to build `contentObject` and must not be null. `contentObject` - An instance of a JAXB-generated class, which will be used as a javax.xml.transform.Source (by marshalling it into XML). It must not be null. Throws: `JAXBException` - if an error is encountered while creating the JAXBSource or if either of the parameters are null.

 public JAXBSource(JAXBContext context,
    Object contentObject) throws JAXBException {
        this(
            ( context == null ) ?
                assertionFailed( Messages.format( Messages.SOURCE_NULL_CONTEXT ) ) :
                context.createMarshaller(),
            ( contentObject == null ) ?
                assertionFailed( Messages.format( Messages.SOURCE_NULL_CONTENT ) ) :
                contentObject);
}

javax.xml.transform.Source

Parameters:

context - JAXBContext that was used to create contentObject. This context is used to create a new instance of marshaller and must not be null.

contentObject - An instance of a JAXB-generated class, which will be used as a javax.xml.transform.Source (by marshalling it into XML). It must not be null.

Throws:

JAXBException - if an error is encountered while creating the JAXBSource or if either of the parameters are null.

 public JAXBSource(Marshaller marshaller,
    Object contentObject) throws JAXBException {
        if( marshaller == null )
            throw new JAXBException(
                Messages.format( Messages.SOURCE_NULL_MARSHALLER ) );
        if( contentObject == null )
            throw new JAXBException(
                Messages.format( Messages.SOURCE_NULL_CONTENT ) );
        this.marshaller = marshaller;
        this.contentObject = contentObject;
        super.setXMLReader(pseudoParser);
        // pass a dummy InputSource. We don't care
        super.setInputSource(new InputSource());
}

javax.xml.transform.Source

Parameters:

marshaller - A marshaller instance that will be used to marshal contentObject into XML. This must be created from a JAXBContext that was used to build contentObject and must not be null.

contentObject - An instance of a JAXB-generated class, which will be used as a javax.xml.transform.Source (by marshalling it into XML). It must not be null.

Throws:

JAXBException - if an error is encountered while creating the JAXBSource or if either of the parameters are null.

Methods from javax.xml.transform.sax.SAXSource:
getInputSource, getSystemId, getXMLReader, setInputSource, setSystemId, setXMLReader, sourceToInputSource

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