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

changeset 286
f50545b5e2f1
child 397
b99d7e355d4b
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/javax/xml/bind/annotation/XmlAttachmentRef.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,74 @@
     1.4 +/*
     1.5 + * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package javax.xml.bind.annotation;
    1.30 +
    1.31 +import javax.activation.DataHandler;
    1.32 +import static java.lang.annotation.ElementType.*;
    1.33 +import java.lang.annotation.Retention;
    1.34 +import static java.lang.annotation.RetentionPolicy.RUNTIME;
    1.35 +import java.lang.annotation.Target;
    1.36 +
    1.37 +/**
    1.38 + * Marks a field/property that its XML form is a uri reference to mime content.
    1.39 + * The mime content is optimally stored out-of-line as an attachment.
    1.40 + *
    1.41 + * A field/property must always map to the {@link DataHandler} class.
    1.42 + *
    1.43 + * <h2>Usage</h2>
    1.44 + * <pre>
    1.45 + * &#64;{@link XmlRootElement}
    1.46 + * class Foo {
    1.47 + *   &#64;{@link XmlAttachmentRef}
    1.48 + *   &#64;{@link XmlAttribute}
    1.49 + *   {@link DataHandler} data;
    1.50 + *
    1.51 + *   &#64;{@link XmlAttachmentRef}
    1.52 + *   &#64;{@link XmlElement}
    1.53 + *   {@link DataHandler} body;
    1.54 + * }
    1.55 + * </pre>
    1.56 + * The above code maps to the following XML:
    1.57 + * <pre>
    1.58 + * &lt;xs:element name="foo" xmlns:ref="http://ws-i.org/profiles/basic/1.1/xsd">
    1.59 + *   &lt;xs:complexType>
    1.60 + *     &lt;xs:sequence>
    1.61 + *       &lt;xs:element name="body" type="ref:swaRef" minOccurs="0" />
    1.62 + *     &lt;/xs:sequence>
    1.63 + *     &lt;xs:attribute name="data" type="ref:swaRef" use="optional" />
    1.64 + *   &lt;/xs:complexType>
    1.65 + * &lt;/xs:element>
    1.66 + * </pre>
    1.67 + *
    1.68 + * <p>
    1.69 + * 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>
    1.70 + *
    1.71 + * @author Kohsuke Kawaguchi
    1.72 + * @since JAXB2.0
    1.73 + */
    1.74 +@Retention(RUNTIME)
    1.75 +@Target({FIELD,METHOD,PARAMETER})
    1.76 +public @interface XmlAttachmentRef {
    1.77 +}

mercurial