src/share/jaxws_classes/javax/xml/bind/util/JAXBResult.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 397
b99d7e355d4b
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

ohair@286 1 /*
mkos@397 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.bind.util;
ohair@286 27
ohair@286 28 import javax.xml.bind.JAXBContext;
ohair@286 29 import javax.xml.bind.JAXBException;
ohair@286 30 import javax.xml.bind.Unmarshaller;
ohair@286 31 import javax.xml.bind.UnmarshallerHandler;
ohair@286 32 import javax.xml.transform.sax.SAXResult;
ohair@286 33
ohair@286 34 /**
ohair@286 35 * JAXP {@link javax.xml.transform.Result} implementation
ohair@286 36 * that unmarshals a JAXB object.
ohair@286 37 *
ohair@286 38 * <p>
ohair@286 39 * This utility class is useful to combine JAXB with
ohair@286 40 * other Java/XML technologies.
ohair@286 41 *
ohair@286 42 * <p>
ohair@286 43 * The following example shows how to use JAXB to unmarshal a document
ohair@286 44 * resulting from an XSLT transformation.
ohair@286 45 *
ohair@286 46 * <blockquote>
ohair@286 47 * <pre>
ohair@286 48 * JAXBResult result = new JAXBResult(
ohair@286 49 * JAXBContext.newInstance("org.acme.foo") );
ohair@286 50 *
ohair@286 51 * // set up XSLT transformation
ohair@286 52 * TransformerFactory tf = TransformerFactory.newInstance();
ohair@286 53 * Transformer t = tf.newTransformer(new StreamSource("test.xsl"));
ohair@286 54 *
ohair@286 55 * // run transformation
ohair@286 56 * t.transform(new StreamSource("document.xml"),result);
ohair@286 57 *
ohair@286 58 * // obtain the unmarshalled content tree
ohair@286 59 * Object o = result.getResult();
ohair@286 60 * </pre>
ohair@286 61 * </blockquote>
ohair@286 62 *
ohair@286 63 * <p>
ohair@286 64 * The fact that JAXBResult derives from SAXResult is an implementation
ohair@286 65 * detail. Thus in general applications are strongly discouraged from
ohair@286 66 * accessing methods defined on SAXResult.
ohair@286 67 *
ohair@286 68 * <p>
ohair@286 69 * In particular it shall never attempt to call the setHandler,
ohair@286 70 * setLexicalHandler, and setSystemId methods.
ohair@286 71 *
ohair@286 72 * @author
ohair@286 73 * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
ohair@286 74 */
ohair@286 75 public class JAXBResult extends SAXResult {
ohair@286 76
ohair@286 77 /**
ohair@286 78 * Creates a new instance that uses the specified
ohair@286 79 * JAXBContext to unmarshal.
ohair@286 80 *
ohair@286 81 * @param context The JAXBContext that will be used to create the
ohair@286 82 * necessary Unmarshaller. This parameter must not be null.
ohair@286 83 * @exception JAXBException if an error is encountered while creating the
ohair@286 84 * JAXBResult or if the context parameter is null.
ohair@286 85 */
ohair@286 86 public JAXBResult( JAXBContext context ) throws JAXBException {
ohair@286 87 this( ( context == null ) ? assertionFailed() : context.createUnmarshaller() );
ohair@286 88 }
ohair@286 89
ohair@286 90 /**
ohair@286 91 * Creates a new instance that uses the specified
ohair@286 92 * Unmarshaller to unmarshal an object.
ohair@286 93 *
ohair@286 94 * <p>
ohair@286 95 * This JAXBResult object will use the specified Unmarshaller
ohair@286 96 * instance. It is the caller's responsibility not to use the
ohair@286 97 * same Unmarshaller for other purposes while it is being
ohair@286 98 * used by this object.
ohair@286 99 *
ohair@286 100 * <p>
ohair@286 101 * The primary purpose of this method is to allow the client
ohair@286 102 * to configure Unmarshaller. Unless you know what you are doing,
ohair@286 103 * it's easier and safer to pass a JAXBContext.
ohair@286 104 *
ohair@286 105 * @param _unmarshaller the unmarshaller. This parameter must not be null.
ohair@286 106 * @throws JAXBException if an error is encountered while creating the
ohair@286 107 * JAXBResult or the Unmarshaller parameter is null.
ohair@286 108 */
ohair@286 109 public JAXBResult( Unmarshaller _unmarshaller ) throws JAXBException {
ohair@286 110 if( _unmarshaller == null )
ohair@286 111 throw new JAXBException(
ohair@286 112 Messages.format( Messages.RESULT_NULL_UNMARSHALLER ) );
ohair@286 113
ohair@286 114 this.unmarshallerHandler = _unmarshaller.getUnmarshallerHandler();
ohair@286 115
ohair@286 116 super.setHandler(unmarshallerHandler);
ohair@286 117 }
ohair@286 118
ohair@286 119 /**
ohair@286 120 * Unmarshaller that will be used to unmarshal
ohair@286 121 * the input documents.
ohair@286 122 */
ohair@286 123 private final UnmarshallerHandler unmarshallerHandler;
ohair@286 124
ohair@286 125 /**
ohair@286 126 * Gets the unmarshalled object created by the transformation.
ohair@286 127 *
ohair@286 128 * @return
ohair@286 129 * Always return a non-null object.
ohair@286 130 *
ohair@286 131 * @exception IllegalStateException
ohair@286 132 * if this method is called before an object is unmarshalled.
ohair@286 133 *
ohair@286 134 * @exception JAXBException
ohair@286 135 * if there is any unmarshalling error.
ohair@286 136 * Note that the implementation is allowed to throw SAXException
ohair@286 137 * during the parsing when it finds an error.
ohair@286 138 */
ohair@286 139 public Object getResult() throws JAXBException {
ohair@286 140 return unmarshallerHandler.getResult();
ohair@286 141 }
ohair@286 142
ohair@286 143 /**
ohair@286 144 * Hook to throw exception from the middle of a contructor chained call
ohair@286 145 * to this
ohair@286 146 */
ohair@286 147 private static Unmarshaller assertionFailed() throws JAXBException {
ohair@286 148 throw new JAXBException( Messages.format( Messages.RESULT_NULL_CONTEXT ) );
ohair@286 149 }
ohair@286 150 }

mercurial