src/share/jaxws_classes/javax/xml/bind/annotation/XmlAttachmentRef.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 397
b99d7e355d4b
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
ohair@286 2 * Copyright (c) 2005, 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 javax.xml.bind.annotation;
ohair@286 27
ohair@286 28 import javax.activation.DataHandler;
ohair@286 29 import static java.lang.annotation.ElementType.*;
ohair@286 30 import java.lang.annotation.Retention;
ohair@286 31 import static java.lang.annotation.RetentionPolicy.RUNTIME;
ohair@286 32 import java.lang.annotation.Target;
ohair@286 33
ohair@286 34 /**
ohair@286 35 * Marks a field/property that its XML form is a uri reference to mime content.
ohair@286 36 * The mime content is optimally stored out-of-line as an attachment.
ohair@286 37 *
ohair@286 38 * A field/property must always map to the {@link DataHandler} class.
ohair@286 39 *
ohair@286 40 * <h2>Usage</h2>
ohair@286 41 * <pre>
ohair@286 42 * &#64;{@link XmlRootElement}
ohair@286 43 * class Foo {
ohair@286 44 * &#64;{@link XmlAttachmentRef}
ohair@286 45 * &#64;{@link XmlAttribute}
ohair@286 46 * {@link DataHandler} data;
ohair@286 47 *
ohair@286 48 * &#64;{@link XmlAttachmentRef}
ohair@286 49 * &#64;{@link XmlElement}
ohair@286 50 * {@link DataHandler} body;
ohair@286 51 * }
ohair@286 52 * </pre>
ohair@286 53 * The above code maps to the following XML:
ohair@286 54 * <pre>
ohair@286 55 * &lt;xs:element name="foo" xmlns:ref="http://ws-i.org/profiles/basic/1.1/xsd">
ohair@286 56 * &lt;xs:complexType>
ohair@286 57 * &lt;xs:sequence>
ohair@286 58 * &lt;xs:element name="body" type="ref:swaRef" minOccurs="0" />
ohair@286 59 * &lt;/xs:sequence>
ohair@286 60 * &lt;xs:attribute name="data" type="ref:swaRef" use="optional" />
ohair@286 61 * &lt;/xs:complexType>
ohair@286 62 * &lt;/xs:element>
ohair@286 63 * </pre>
ohair@286 64 *
ohair@286 65 * <p>
ohair@286 66 * The above binding supports WS-I AP 1.0 <a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html#Referencing_Attachments_from_the_SOAP_Envelope">WS-I Attachments Profile Version 1.0.</a>
ohair@286 67 *
ohair@286 68 * @author Kohsuke Kawaguchi
ohair@286 69 * @since JAXB2.0
ohair@286 70 */
ohair@286 71 @Retention(RUNTIME)
ohair@286 72 @Target({FIELD,METHOD,PARAMETER})
ohair@286 73 public @interface XmlAttachmentRef {
ohair@286 74 }

mercurial