All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.bind.api.Bridge Maven / Gradle / Ivy

There is a newer version: 4.0.5
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.xml.bind.api;

import java.io.InputStream;
import java.io.OutputStream;

import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.attachment.AttachmentMarshaller;
import javax.xml.bind.attachment.AttachmentUnmarshaller;
import javax.xml.namespace.NamespaceContext;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.Result;
import javax.xml.transform.Source;

import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import com.sun.xml.bind.v2.runtime.BridgeContextImpl;
import com.sun.xml.bind.v2.runtime.JAXBContextImpl;

import org.w3c.dom.Node;
import org.xml.sax.ContentHandler;

/**
 * Mini-marshaller/unmarshaller that is specialized for a particular
 * element name and a type.
 *
 * 

* Instances of this class is stateless and multi-thread safe. * They are reentrant. * *

* All the marshal operation generates fragments. * *

* Subject to change without notice. * * @since JAXB 2.0 EA1 * @author Kohsuke Kawaguchi */ public abstract class Bridge { protected Bridge(JAXBContextImpl context) { this.context = context; } protected final JAXBContextImpl context; /** * Gets the {@link JAXBRIContext} to which this object belongs. * * @since 2.1 */ public @NotNull JAXBRIContext getContext() { return context; } /** * * @throws JAXBException * if there was an error while marshalling. * * @since 2.0 EA1 */ public final void marshal(T object,XMLStreamWriter output) throws JAXBException { marshal(object,output,null); } public final void marshal(T object,XMLStreamWriter output, AttachmentMarshaller am) throws JAXBException { Marshaller m = context.marshallerPool.take(); m.setAttachmentMarshaller(am); marshal(m,object,output); m.setAttachmentMarshaller(null); context.marshallerPool.recycle(m); } public final void marshal(@NotNull BridgeContext context,T object,XMLStreamWriter output) throws JAXBException { marshal( ((BridgeContextImpl)context).marshaller, object, output ); } public abstract void marshal(@NotNull Marshaller m,T object,XMLStreamWriter output) throws JAXBException; /** * Marshals the specified type object with the implicit element name * associated with this instance of {@link Bridge}. * * @param nsContext * if this marshalling is done to marshal a subelement, this {@link NamespaceContext} * represents in-scope namespace bindings available for that element. Can be null, * in which case JAXB assumes no in-scope namespaces. * @throws JAXBException * if there was an error while marshalling. * * @since 2.0 EA1 */ public void marshal(T object,OutputStream output, NamespaceContext nsContext) throws JAXBException { marshal(object,output,nsContext,null); } /** * @since 2.0.2 */ public void marshal(T object,OutputStream output, NamespaceContext nsContext, AttachmentMarshaller am) throws JAXBException { Marshaller m = context.marshallerPool.take(); m.setAttachmentMarshaller(am); marshal(m,object,output,nsContext); m.setAttachmentMarshaller(null); context.marshallerPool.recycle(m); } public final void marshal(@NotNull BridgeContext context,T object,OutputStream output, NamespaceContext nsContext) throws JAXBException { marshal( ((BridgeContextImpl)context).marshaller, object, output, nsContext ); } public abstract void marshal(@NotNull Marshaller m,T object,OutputStream output, NamespaceContext nsContext) throws JAXBException; public final void marshal(T object,Node output) throws JAXBException { Marshaller m = context.marshallerPool.take(); marshal(m,object,output); context.marshallerPool.recycle(m); } public final void marshal(@NotNull BridgeContext context,T object,Node output) throws JAXBException { marshal( ((BridgeContextImpl)context).marshaller, object, output ); } public abstract void marshal(@NotNull Marshaller m,T object,Node output) throws JAXBException; /** * @since 2.0 EA4 */ public final void marshal(T object, ContentHandler contentHandler) throws JAXBException { marshal(object,contentHandler,null); } /** * @since 2.0.2 */ public final void marshal(T object, ContentHandler contentHandler, AttachmentMarshaller am) throws JAXBException { Marshaller m = context.marshallerPool.take(); m.setAttachmentMarshaller(am); marshal(m,object,contentHandler); m.setAttachmentMarshaller(null); context.marshallerPool.recycle(m); } public final void marshal(@NotNull BridgeContext context,T object, ContentHandler contentHandler) throws JAXBException { marshal( ((BridgeContextImpl)context).marshaller, object, contentHandler ); } public abstract void marshal(@NotNull Marshaller m,T object, ContentHandler contentHandler) throws JAXBException; /** * @since 2.0 EA4 */ public final void marshal(T object, Result result) throws JAXBException { Marshaller m = context.marshallerPool.take(); marshal(m,object,result); context.marshallerPool.recycle(m); } public final void marshal(@NotNull BridgeContext context,T object, Result result) throws JAXBException { marshal( ((BridgeContextImpl)context).marshaller, object, result ); } public abstract void marshal(@NotNull Marshaller m,T object, Result result) throws JAXBException; private T exit(T r, Unmarshaller u) { u.setAttachmentUnmarshaller(null); context.unmarshallerPool.recycle(u); return r; } /** * Unmarshals the specified type object. * * @param in * the parser must be pointing at a start tag * that encloses the XML type that this {@link Bridge} is * instanciated for. * * @return * never null. * * @throws JAXBException * if there was an error while unmarshalling. * * @since 2.0 EA1 */ public final @NotNull T unmarshal(@NotNull XMLStreamReader in) throws JAXBException { return unmarshal(in,null); } /** * @since 2.0.3 */ public final @NotNull T unmarshal(@NotNull XMLStreamReader in, @Nullable AttachmentUnmarshaller au) throws JAXBException { Unmarshaller u = context.unmarshallerPool.take(); u.setAttachmentUnmarshaller(au); return exit(unmarshal(u,in),u); } public final @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull XMLStreamReader in) throws JAXBException { return unmarshal( ((BridgeContextImpl)context).unmarshaller, in ); } public abstract @NotNull T unmarshal(@NotNull Unmarshaller u, @NotNull XMLStreamReader in) throws JAXBException; /** * Unmarshals the specified type object. * * @param in * the parser must be pointing at a start tag * that encloses the XML type that this {@link Bridge} is * instanciated for. * * @return * never null. * * @throws JAXBException * if there was an error while unmarshalling. * * @since 2.0 EA1 */ public final @NotNull T unmarshal(@NotNull Source in) throws JAXBException { return unmarshal(in,null); } /** * @since 2.0.3 */ public final @NotNull T unmarshal(@NotNull Source in, @Nullable AttachmentUnmarshaller au) throws JAXBException { Unmarshaller u = context.unmarshallerPool.take(); u.setAttachmentUnmarshaller(au); return exit(unmarshal(u,in),u); } public final @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull Source in) throws JAXBException { return unmarshal( ((BridgeContextImpl)context).unmarshaller, in ); } public abstract @NotNull T unmarshal(@NotNull Unmarshaller u, @NotNull Source in) throws JAXBException; /** * Unmarshals the specified type object. * * @param in * the parser must be pointing at a start tag * that encloses the XML type that this {@link Bridge} is * instanciated for. * * @return * never null. * * @throws JAXBException * if there was an error while unmarshalling. * * @since 2.0 EA1 */ public final @NotNull T unmarshal(@NotNull InputStream in) throws JAXBException { Unmarshaller u = context.unmarshallerPool.take(); return exit(unmarshal(u,in),u); } public final @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull InputStream in) throws JAXBException { return unmarshal( ((BridgeContextImpl)context).unmarshaller, in ); } public abstract @NotNull T unmarshal(@NotNull Unmarshaller u, @NotNull InputStream in) throws JAXBException; /** * Unmarshals the specified type object. * * @param n * Node to be unmarshalled. * * @return * never null. * * @throws JAXBException * if there was an error while unmarshalling. * * @since 2.0 FCS */ public final @NotNull T unmarshal(@NotNull Node n) throws JAXBException { return unmarshal(n,null); } /** * @since 2.0.3 */ public final @NotNull T unmarshal(@NotNull Node n, @Nullable AttachmentUnmarshaller au) throws JAXBException { Unmarshaller u = context.unmarshallerPool.take(); u.setAttachmentUnmarshaller(au); return exit(unmarshal(u,n),u); } public final @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull Node n) throws JAXBException { return unmarshal( ((BridgeContextImpl)context).unmarshaller, n ); } public abstract @NotNull T unmarshal(@NotNull Unmarshaller context, @NotNull Node n) throws JAXBException; /** * Gets the {@link TypeReference} from which this bridge was created. */ public abstract TypeReference getTypeReference(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy