Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/bind/annotation/XmlIsSet.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/bind/annotation/XmlIsSet.java
Thu, 12 Oct 2017 19:44:07 +0800
- author
- aoqi
- date
- Thu, 12 Oct 2017 19:44:07 +0800
- changeset 760
- e530533619ec
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, 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 com.sun.xml.internal.bind.annotation; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.lang.annotation.Retention; |
| aoqi@0 | 29 | import java.lang.annotation.Target; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | import javax.xml.bind.annotation.XmlAttribute; |
| aoqi@0 | 32 | import javax.xml.bind.annotation.XmlElement; |
| aoqi@0 | 33 | import javax.xml.bind.annotation.XmlElementRef; |
| aoqi@0 | 34 | import javax.xml.bind.annotation.XmlValue; |
| aoqi@0 | 35 | |
| aoqi@0 | 36 | import static java.lang.annotation.ElementType.FIELD; |
| aoqi@0 | 37 | import static java.lang.annotation.ElementType.METHOD; |
| aoqi@0 | 38 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
| aoqi@0 | 39 | |
| aoqi@0 | 40 | /** |
| aoqi@0 | 41 | * Designates a boolean field/property as a flag to indicate |
| aoqi@0 | 42 | * whether another property is present or not. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * <p> |
| aoqi@0 | 45 | * Sometimes you'd want to map a Java primitive type to an |
| aoqi@0 | 46 | * optional element/attribute. Doing this makes it impossible |
| aoqi@0 | 47 | * to represent the absence of the property, thus you always |
| aoqi@0 | 48 | * end up producing the value when you marshal to XML. |
| aoqi@0 | 49 | * |
| aoqi@0 | 50 | * For example, |
| aoqi@0 | 51 | * <pre> |
| aoqi@0 | 52 | * {@link XmlElement} |
| aoqi@0 | 53 | * class Foo { |
| aoqi@0 | 54 | * {@link XmlElement} |
| aoqi@0 | 55 | * int x; |
| aoqi@0 | 56 | * } |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * marshaller.marshal(new Foo()); |
| aoqi@0 | 59 | * </pre> |
| aoqi@0 | 60 | * and you get: |
| aoqi@0 | 61 | * <pre><xmp> |
| aoqi@0 | 62 | * <foo><x>0</x></foo> |
| aoqi@0 | 63 | * </xmp></pre> |
| aoqi@0 | 64 | * |
| aoqi@0 | 65 | * <p> |
| aoqi@0 | 66 | * By creating a side boolean field/property that has this annotation, |
| aoqi@0 | 67 | * you can indicate the absence of the property by setting this boolean |
| aoqi@0 | 68 | * to false. |
| aoqi@0 | 69 | * <pre> |
| aoqi@0 | 70 | * {@link XmlElement} |
| aoqi@0 | 71 | * class Foo { |
| aoqi@0 | 72 | * {@link XmlElement} |
| aoqi@0 | 73 | * int x; |
| aoqi@0 | 74 | * {@link XmlIsSet}("x") |
| aoqi@0 | 75 | * boolean xIsPresent; |
| aoqi@0 | 76 | * } |
| aoqi@0 | 77 | * |
| aoqi@0 | 78 | * Foo f = new Foo(); |
| aoqi@0 | 79 | * f.x = 5; |
| aoqi@0 | 80 | * f.xIsPresent = false; |
| aoqi@0 | 81 | * |
| aoqi@0 | 82 | * marshaller.marshal(f); |
| aoqi@0 | 83 | * |
| aoqi@0 | 84 | * <xmp> |
| aoqi@0 | 85 | * <foo/> |
| aoqi@0 | 86 | * </xmp> |
| aoqi@0 | 87 | * |
| aoqi@0 | 88 | * f.xIsPresent = true; |
| aoqi@0 | 89 | * <xmp> |
| aoqi@0 | 90 | * <foo><x>5</x></foo> |
| aoqi@0 | 91 | * </xmp> |
| aoqi@0 | 92 | * </pre> |
| aoqi@0 | 93 | * |
| aoqi@0 | 94 | * <p> |
| aoqi@0 | 95 | * A property/field annotated with {@link XmlIsSet} itself will not show up in XML. |
| aoqi@0 | 96 | * It is an error to use this annotation on the same property/field |
| aoqi@0 | 97 | * as {@link XmlElement}, {@link XmlAttribute}, {@link XmlValue}, or {@link XmlElementRef}, |
| aoqi@0 | 98 | * ...<b>TBD</b>. |
| aoqi@0 | 99 | * |
| aoqi@0 | 100 | * @deprecated |
| aoqi@0 | 101 | * this hasn't been implemented in the RI, and this hasn't been speced yet. |
| aoqi@0 | 102 | * I believe Joe asked for this feature. I'd like to drop this. |
| aoqi@0 | 103 | * |
| aoqi@0 | 104 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 105 | */ |
| aoqi@0 | 106 | @Retention(RUNTIME) |
| aoqi@0 | 107 | @Target({FIELD,METHOD}) |
| aoqi@0 | 108 | public @interface XmlIsSet { |
| aoqi@0 | 109 | /** |
| aoqi@0 | 110 | * Specifies the name of the property to attach to. |
| aoqi@0 | 111 | */ |
| aoqi@0 | 112 | String value(); |
| aoqi@0 | 113 | } |
