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