/*
 * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.bind.annotation;

import javax.activation.DataHandler;
import static java.lang.annotation.ElementType.*;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;

Marks a field/property that its XML form is a uri reference to mime content. The mime content is optimally stored out-of-line as an attachment. A field/property must always map to the DataHandler class.

Usage

@XmlRootElement class Foo { @XmlAttachmentRef @XmlAttribute DataHandler data; @XmlAttachmentRef @XmlElement DataHandler body; } 
The above code maps to the following XML:

<xs:element name="foo" xmlns:ref="http://ws-i.org/profiles/basic/1.1/xsd">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="body" type="ref:swaRef" minOccurs="0" />
    </xs:sequence>
    <xs:attribute name="data" type="ref:swaRef" use="optional" />
  </xs:complexType>
</xs:element>

The above binding supports WS-I AP 1.0 WS-I Attachments Profile Version 1.0.

Author:Kohsuke Kawaguchi
Since:1.6, JAXB 2.0
/** * Marks a field/property that its XML form is a uri reference to mime content. * The mime content is optimally stored out-of-line as an attachment. * * A field/property must always map to the {@link DataHandler} class. * * <h2>Usage</h2> * <pre> * &#64;{@link XmlRootElement} * class Foo { * &#64;{@link XmlAttachmentRef} * &#64;{@link XmlAttribute} * {@link DataHandler} data; * * &#64;{@link XmlAttachmentRef} * &#64;{@link XmlElement} * {@link DataHandler} body; * } * </pre> * The above code maps to the following XML: * <pre>{@code * <xs:element name="foo" xmlns:ref="http://ws-i.org/profiles/basic/1.1/xsd"> * <xs:complexType> * <xs:sequence> * <xs:element name="body" type="ref:swaRef" minOccurs="0" /> * </xs:sequence> * <xs:attribute name="data" type="ref:swaRef" use="optional" /> * </xs:complexType> * </xs:element> * }</pre> * * <p> * 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> * * @author Kohsuke Kawaguchi * @since 1.6, JAXB 2.0 */
@Retention(RUNTIME) @Target({FIELD,METHOD,PARAMETER}) public @interface XmlAttachmentRef { }