1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/bind/annotation/XmlIsSet.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,113 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.xml.internal.bind.annotation;
1.30 +
1.31 +import java.lang.annotation.Retention;
1.32 +import java.lang.annotation.Target;
1.33 +
1.34 +import javax.xml.bind.annotation.XmlAttribute;
1.35 +import javax.xml.bind.annotation.XmlElement;
1.36 +import javax.xml.bind.annotation.XmlElementRef;
1.37 +import javax.xml.bind.annotation.XmlValue;
1.38 +
1.39 +import static java.lang.annotation.ElementType.FIELD;
1.40 +import static java.lang.annotation.ElementType.METHOD;
1.41 +import static java.lang.annotation.RetentionPolicy.RUNTIME;
1.42 +
1.43 +/**
1.44 + * Designates a boolean field/property as a flag to indicate
1.45 + * whether another property is present or not.
1.46 + *
1.47 + * <p>
1.48 + * Sometimes you'd want to map a Java primitive type to an
1.49 + * optional element/attribute. Doing this makes it impossible
1.50 + * to represent the absence of the property, thus you always
1.51 + * end up producing the value when you marshal to XML.
1.52 + *
1.53 + * For example,
1.54 + * <pre>
1.55 + * {@link XmlElement}
1.56 + * class Foo {
1.57 + * {@link XmlElement}
1.58 + * int x;
1.59 + * }
1.60 + *
1.61 + * marshaller.marshal(new Foo());
1.62 + * </pre>
1.63 + * and you get:
1.64 + * <pre><xmp>
1.65 + * <foo><x>0</x></foo>
1.66 + * </xmp></pre>
1.67 + *
1.68 + * <p>
1.69 + * By creating a side boolean field/property that has this annotation,
1.70 + * you can indicate the absence of the property by setting this boolean
1.71 + * to false.
1.72 + * <pre>
1.73 + * {@link XmlElement}
1.74 + * class Foo {
1.75 + * {@link XmlElement}
1.76 + * int x;
1.77 + * {@link XmlIsSet}("x")
1.78 + * boolean xIsPresent;
1.79 + * }
1.80 + *
1.81 + * Foo f = new Foo();
1.82 + * f.x = 5;
1.83 + * f.xIsPresent = false;
1.84 + *
1.85 + * marshaller.marshal(f);
1.86 + *
1.87 + * <xmp>
1.88 + * <foo/>
1.89 + * </xmp>
1.90 + *
1.91 + * f.xIsPresent = true;
1.92 + * <xmp>
1.93 + * <foo><x>5</x></foo>
1.94 + * </xmp>
1.95 + * </pre>
1.96 + *
1.97 + * <p>
1.98 + * A property/field annotated with {@link XmlIsSet} itself will not show up in XML.
1.99 + * It is an error to use this annotation on the same property/field
1.100 + * as {@link XmlElement}, {@link XmlAttribute}, {@link XmlValue}, or {@link XmlElementRef},
1.101 + * ...<b>TBD</b>.
1.102 + *
1.103 + * @deprecated
1.104 + * this hasn't been implemented in the RI, and this hasn't been speced yet.
1.105 + * I believe Joe asked for this feature. I'd like to drop this.
1.106 + *
1.107 + * @author Kohsuke Kawaguchi
1.108 + */
1.109 +@Retention(RUNTIME)
1.110 +@Target({FIELD,METHOD})
1.111 +public @interface XmlIsSet {
1.112 + /**
1.113 + * Specifies the name of the property to attach to.
1.114 + */
1.115 + String value();
1.116 +}
