aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.xml.bind.annotation;
aoqi@0: 
aoqi@0: import javax.activation.DataHandler;
aoqi@0: import static java.lang.annotation.ElementType.*;
aoqi@0: import java.lang.annotation.Retention;
aoqi@0: import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0: import java.lang.annotation.Target;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Marks a field/property that its XML form is a uri reference to mime content.
aoqi@0:  * The mime content is optimally stored out-of-line as an attachment.
aoqi@0:  *
aoqi@0:  * A field/property must always map to the {@link DataHandler} class.
aoqi@0:  *
aoqi@0:  * <h2>Usage</h2>
aoqi@0:  * <pre>
aoqi@0:  * &#64;{@link XmlRootElement}
aoqi@0:  * class Foo {
aoqi@0:  *   &#64;{@link XmlAttachmentRef}
aoqi@0:  *   &#64;{@link XmlAttribute}
aoqi@0:  *   {@link DataHandler} data;
aoqi@0:  *
aoqi@0:  *   &#64;{@link XmlAttachmentRef}
aoqi@0:  *   &#64;{@link XmlElement}
aoqi@0:  *   {@link DataHandler} body;
aoqi@0:  * }
aoqi@0:  * </pre>
aoqi@0:  * The above code maps to the following XML:
aoqi@0:  * <pre>
aoqi@0:  * &lt;xs:element name="foo" xmlns:ref="http://ws-i.org/profiles/basic/1.1/xsd">
aoqi@0:  *   &lt;xs:complexType>
aoqi@0:  *     &lt;xs:sequence>
aoqi@0:  *       &lt;xs:element name="body" type="ref:swaRef" minOccurs="0" />
aoqi@0:  *     &lt;/xs:sequence>
aoqi@0:  *     &lt;xs:attribute name="data" type="ref:swaRef" use="optional" />
aoqi@0:  *   &lt;/xs:complexType>
aoqi@0:  * &lt;/xs:element>
aoqi@0:  * </pre>
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * 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>
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  * @since JAXB2.0
aoqi@0:  */
aoqi@0: @Retention(RUNTIME)
aoqi@0: @Target({FIELD,METHOD,PARAMETER})
aoqi@0: public @interface XmlAttachmentRef {
aoqi@0: }