src/share/jaxws_classes/com/sun/xml/internal/ws/spi/db/XMLBridge.java

Tue, 06 Mar 2012 16:09:35 -0800

author
ohair
date
Tue, 06 Mar 2012 16:09:35 -0800
changeset 286
f50545b5e2f1
child 368
0989ad8c0860
permissions
-rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

ohair@286 1 /*
ohair@286 2 * Copyright (c) 1997, 2011, 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 com.sun.xml.internal.ws.spi.db;
ohair@286 27
ohair@286 28 import java.io.InputStream;
ohair@286 29 import java.io.OutputStream;
ohair@286 30
ohair@286 31 import javax.xml.bind.JAXBException;
ohair@286 32 import javax.xml.bind.attachment.AttachmentMarshaller;
ohair@286 33 import javax.xml.bind.attachment.AttachmentUnmarshaller;
ohair@286 34 import javax.xml.namespace.NamespaceContext;
ohair@286 35 import javax.xml.stream.XMLStreamReader;
ohair@286 36 import javax.xml.stream.XMLStreamWriter;
ohair@286 37 import javax.xml.transform.Result;
ohair@286 38 import javax.xml.transform.Source;
ohair@286 39
ohair@286 40 import com.sun.istack.internal.NotNull;
ohair@286 41 import com.sun.istack.internal.Nullable;
ohair@286 42 import org.w3c.dom.Node;
ohair@286 43 import org.xml.sax.ContentHandler;
ohair@286 44
ohair@286 45 /**
ohair@286 46 * The XMLBridge is a Glassfish JAXWS side of Glassfish JAXB Bridge.
ohair@286 47 *
ohair@286 48 * Mini-marshaller/unmarshaller that is specialized for a particular
ohair@286 49 * element name and a type.
ohair@286 50 *
ohair@286 51 * <p>
ohair@286 52 * Instances of this class is stateless and multi-thread safe.
ohair@286 53 * They are reentrant.
ohair@286 54 *
ohair@286 55 * <p>
ohair@286 56 * All the marshal operation generates fragments.
ohair@286 57 *
ohair@286 58 * <p>
ohair@286 59 * <b>Subject to change without notice</b>.
ohair@286 60 *
ohair@286 61 * @since JAXB 2.0 EA1
ohair@286 62 * @author Kohsuke Kawaguchi
ohair@286 63 * @author shih-chang.chen@oracle.com
ohair@286 64 */
ohair@286 65 public interface XMLBridge<T> {
ohair@286 66 /**
ohair@286 67 * Gets the {@link BindingContext} to which this object belongs.
ohair@286 68 *
ohair@286 69 * @since 2.1
ohair@286 70 */
ohair@286 71 public @NotNull BindingContext context();
ohair@286 72
ohair@286 73 /**
ohair@286 74 *
ohair@286 75 * @throws JAXBException
ohair@286 76 * if there was an error while marshalling.
ohair@286 77 *
ohair@286 78 * @since 2.0 EA1
ohair@286 79 */
ohair@286 80 // public void marshal(T object,XMLStreamWriter output) throws JAXBException;
ohair@286 81
ohair@286 82 public void marshal(T object,XMLStreamWriter output, AttachmentMarshaller am) throws JAXBException;
ohair@286 83
ohair@286 84 /**
ohair@286 85 * Marshals the specified type object with the implicit element name
ohair@286 86 * associated with this instance of {@link Bond}.
ohair@286 87 *
ohair@286 88 * @param nsContext
ohair@286 89 * if this marshalling is done to marshal a subelement, this {@link NamespaceContext}
ohair@286 90 * represents in-scope namespace bindings available for that element. Can be null,
ohair@286 91 * in which case JAXB assumes no in-scope namespaces.
ohair@286 92 * @throws JAXBException
ohair@286 93 * if there was an error while marshalling.
ohair@286 94 *
ohair@286 95 * @since 2.0 EA1
ohair@286 96 */
ohair@286 97 // public void marshal(T object,OutputStream output, NamespaceContext nsContext) throws JAXBException;
ohair@286 98
ohair@286 99 /**
ohair@286 100 * @since 2.0.2
ohair@286 101 */
ohair@286 102 public void marshal(T object,OutputStream output, NamespaceContext nsContext, AttachmentMarshaller am) throws JAXBException ;
ohair@286 103 //
ohair@286 104 //// public void marshal(@NotNull BridgeContext context,T object,OutputStream output, NamespaceContext nsContext) throws JAXBException;
ohair@286 105 //
ohair@286 106 // public void marshal(@NotNull Marshaller m,T object,OutputStream output, NamespaceContext nsContext) throws JAXBException;
ohair@286 107
ohair@286 108
ohair@286 109 public void marshal(T object,Node output) throws JAXBException ;
ohair@286 110 //
ohair@286 111 //// public void marshal(@NotNull BridgeContext context,T object,Node output) throws JAXBException ;
ohair@286 112 //
ohair@286 113 // public void marshal(@NotNull Marshaller m,T object,Node output) throws JAXBException;
ohair@286 114
ohair@286 115
ohair@286 116 /**
ohair@286 117 * @since 2.0 EA4
ohair@286 118 */
ohair@286 119 // public void marshal(T object, ContentHandler contentHandler) throws JAXBException;
ohair@286 120 /**
ohair@286 121 * @since 2.0.2
ohair@286 122 */
ohair@286 123 public void marshal(T object, ContentHandler contentHandler, AttachmentMarshaller am) throws JAXBException ;
ohair@286 124
ohair@286 125 //// public void marshal(@NotNull BridgeContext context,T object, ContentHandler contentHandler) throws JAXBException;
ohair@286 126 //
ohair@286 127 // public void marshal(@NotNull Marshaller m,T object, ContentHandler contentHandler) throws JAXBException;
ohair@286 128
ohair@286 129 /**
ohair@286 130 * @since 2.0 EA4
ohair@286 131 */
ohair@286 132 public void marshal(T object, Result result) throws JAXBException;
ohair@286 133
ohair@286 134 //// public void marshal(@NotNull BridgeContext context,T object, Result result) throws JAXBException;
ohair@286 135 // public void marshal(@NotNull Marshaller m,T object, Result result) throws JAXBException;
ohair@286 136
ohair@286 137
ohair@286 138
ohair@286 139 /**
ohair@286 140 * Unmarshals the specified type object.
ohair@286 141 *
ohair@286 142 * @param in
ohair@286 143 * the parser must be pointing at a start tag
ohair@286 144 * that encloses the XML type that this {@link Bond} is
ohair@286 145 * instanciated for.
ohair@286 146 *
ohair@286 147 * @return
ohair@286 148 * never null.
ohair@286 149 *
ohair@286 150 * @throws JAXBException
ohair@286 151 * if there was an error while unmarshalling.
ohair@286 152 *
ohair@286 153 * @since 2.0 EA1
ohair@286 154 */
ohair@286 155 // public @NotNull T unmarshal(@NotNull XMLStreamReader in) throws JAXBException ;
ohair@286 156 /**
ohair@286 157 * @since 2.0.3
ohair@286 158 */
ohair@286 159 public @NotNull T unmarshal(@NotNull XMLStreamReader in, @Nullable AttachmentUnmarshaller au) throws JAXBException;
ohair@286 160 // public @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull XMLStreamReader in) throws JAXBException ;
ohair@286 161 // public @NotNull T unmarshal(@NotNull Unmarshaller u, @NotNull XMLStreamReader in) throws JAXBException;
ohair@286 162
ohair@286 163 /**
ohair@286 164 * Unmarshals the specified type object.
ohair@286 165 *
ohair@286 166 * @param in
ohair@286 167 * the parser must be pointing at a start tag
ohair@286 168 * that encloses the XML type that this {@link Bond} is
ohair@286 169 * instanciated for.
ohair@286 170 *
ohair@286 171 * @return
ohair@286 172 * never null.
ohair@286 173 *
ohair@286 174 * @throws JAXBException
ohair@286 175 * if there was an error while unmarshalling.
ohair@286 176 *
ohair@286 177 * @since 2.0 EA1
ohair@286 178 */
ohair@286 179 // public @NotNull T unmarshal(@NotNull Source in) throws JAXBException ;
ohair@286 180 /**
ohair@286 181 * @since 2.0.3
ohair@286 182 */
ohair@286 183 public @NotNull T unmarshal(@NotNull Source in, @Nullable AttachmentUnmarshaller au) throws JAXBException;
ohair@286 184 // public @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull Source in) throws JAXBException;
ohair@286 185 // public @NotNull T unmarshal(@NotNull Unmarshaller u, @NotNull Source in) throws JAXBException;
ohair@286 186
ohair@286 187 /**
ohair@286 188 * Unmarshals the specified type object.
ohair@286 189 *
ohair@286 190 * @param in
ohair@286 191 * the parser must be pointing at a start tag
ohair@286 192 * that encloses the XML type that this {@link XMLBridge} is
ohair@286 193 * instanciated for.
ohair@286 194 *
ohair@286 195 * @return
ohair@286 196 * never null.
ohair@286 197 *
ohair@286 198 * @throws JAXBException
ohair@286 199 * if there was an error while unmarshalling.
ohair@286 200 *
ohair@286 201 * @since 2.0 EA1
ohair@286 202 */
ohair@286 203 public @NotNull T unmarshal(@NotNull InputStream in) throws JAXBException ;
ohair@286 204
ohair@286 205 // public @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull InputStream in) throws JAXBException ;
ohair@286 206
ohair@286 207 // public @NotNull T unmarshal(@NotNull Unmarshaller u, @NotNull InputStream in) throws JAXBException;
ohair@286 208
ohair@286 209 /**
ohair@286 210 * Unmarshals the specified type object.
ohair@286 211 *
ohair@286 212 * @param n
ohair@286 213 * Node to be unmarshalled.
ohair@286 214 *
ohair@286 215 * @return
ohair@286 216 * never null.
ohair@286 217 *
ohair@286 218 * @throws JAXBException
ohair@286 219 * if there was an error while unmarshalling.
ohair@286 220 *
ohair@286 221 * @since 2.0 FCS
ohair@286 222 */
ohair@286 223 // public @NotNull T unmarshal(@NotNull Node n) throws JAXBException ;
ohair@286 224 /**
ohair@286 225 * @since 2.0.3
ohair@286 226 */
ohair@286 227 public @NotNull T unmarshal(@NotNull Node n, @Nullable AttachmentUnmarshaller au) throws JAXBException;
ohair@286 228 // public @NotNull T unmarshal(@NotNull BridgeContext context, @NotNull Node n) throws JAXBException;
ohair@286 229 // public @NotNull T unmarshal(@NotNull Unmarshaller context, @NotNull Node n) throws JAXBException;
ohair@286 230
ohair@286 231 /**
ohair@286 232 * Gets the {@link TypeInfo} from which this bridge was created.
ohair@286 233 */
ohair@286 234 public TypeInfo getTypeInfo();
ohair@286 235
ohair@286 236 /**
ohair@286 237 * This can be used to determine whether XMLStreamWriter or OutputStream is
ohair@286 238 * prefered by the implementation.
ohair@286 239 *
ohair@286 240 * @return true if marshall to OutputStream is supported in the
ohair@286 241 * implementation.
ohair@286 242 */
ohair@286 243 public boolean supportOutputStream();
ohair@286 244 }

mercurial