Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package javax.xml.bind.annotation; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import javax.activation.DataHandler; |
aoqi@0 | 29 | import static java.lang.annotation.ElementType.*; |
aoqi@0 | 30 | import java.lang.annotation.Retention; |
aoqi@0 | 31 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
aoqi@0 | 32 | import java.lang.annotation.Target; |
aoqi@0 | 33 | |
aoqi@0 | 34 | /** |
aoqi@0 | 35 | * Marks a field/property that its XML form is a uri reference to mime content. |
aoqi@0 | 36 | * The mime content is optimally stored out-of-line as an attachment. |
aoqi@0 | 37 | * |
aoqi@0 | 38 | * A field/property must always map to the {@link DataHandler} class. |
aoqi@0 | 39 | * |
aoqi@0 | 40 | * <h2>Usage</h2> |
aoqi@0 | 41 | * <pre> |
aoqi@0 | 42 | * @{@link XmlRootElement} |
aoqi@0 | 43 | * class Foo { |
aoqi@0 | 44 | * @{@link XmlAttachmentRef} |
aoqi@0 | 45 | * @{@link XmlAttribute} |
aoqi@0 | 46 | * {@link DataHandler} data; |
aoqi@0 | 47 | * |
aoqi@0 | 48 | * @{@link XmlAttachmentRef} |
aoqi@0 | 49 | * @{@link XmlElement} |
aoqi@0 | 50 | * {@link DataHandler} body; |
aoqi@0 | 51 | * } |
aoqi@0 | 52 | * </pre> |
aoqi@0 | 53 | * The above code maps to the following XML: |
aoqi@0 | 54 | * <pre> |
aoqi@0 | 55 | * <xs:element name="foo" xmlns:ref="http://ws-i.org/profiles/basic/1.1/xsd"> |
aoqi@0 | 56 | * <xs:complexType> |
aoqi@0 | 57 | * <xs:sequence> |
aoqi@0 | 58 | * <xs:element name="body" type="ref:swaRef" minOccurs="0" /> |
aoqi@0 | 59 | * </xs:sequence> |
aoqi@0 | 60 | * <xs:attribute name="data" type="ref:swaRef" use="optional" /> |
aoqi@0 | 61 | * </xs:complexType> |
aoqi@0 | 62 | * </xs:element> |
aoqi@0 | 63 | * </pre> |
aoqi@0 | 64 | * |
aoqi@0 | 65 | * <p> |
aoqi@0 | 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> |
aoqi@0 | 67 | * |
aoqi@0 | 68 | * @author Kohsuke Kawaguchi |
aoqi@0 | 69 | * @since JAXB2.0 |
aoqi@0 | 70 | */ |
aoqi@0 | 71 | @Retention(RUNTIME) |
aoqi@0 | 72 | @Target({FIELD,METHOD,PARAMETER}) |
aoqi@0 | 73 | public @interface XmlAttachmentRef { |
aoqi@0 | 74 | } |