|
|
The XmlIsSet.java Java example source code
/*
* Copyright (c) 1997, 2011, 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 com.sun.xml.internal.bind.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementRef;
import javax.xml.bind.annotation.XmlValue;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Designates a boolean field/property as a flag to indicate
* whether another property is present or not.
*
* <p>
* Sometimes you'd want to map a Java primitive type to an
* optional element/attribute. Doing this makes it impossible
* to represent the absence of the property, thus you always
* end up producing the value when you marshal to XML.
*
* For example,
* <pre>
* {@link XmlElement}
* class Foo {
* {@link XmlElement}
* int x;
* }
*
* marshaller.marshal(new Foo());
* </pre>
* and you get:
* <pre><![CDATA[
* <foo><x>0</x></foo>
* </xmp></pre>
*
* <p>
* By creating a side boolean field/property that has this annotation,
* you can indicate the absence of the property by setting this boolean
* to false.
* <pre>
* {@link XmlElement}
* class Foo {
* {@link XmlElement}
* int x;
* {@link XmlIsSet}("x")
* boolean xIsPresent;
* }
*
* Foo f = new Foo();
* f.x = 5;
* f.xIsPresent = false;
*
* marshaller.marshal(f);
*
* <xmp>
* <foo/>
* </xmp>
*
* f.xIsPresent = true;
* <xmp>
* <foo><x>5</x></foo>
* </xmp>
* </pre>
*
* <p>
* A property/field annotated with {@link XmlIsSet} itself will not show up in XML.
* It is an error to use this annotation on the same property/field
* as {@link XmlElement}, {@link XmlAttribute}, {@link XmlValue}, or {@link XmlElementRef},
* ...<b>TBD</b>.
*
* @deprecated
* this hasn't been implemented in the RI, and this hasn't been speced yet.
* I believe Joe asked for this feature. I'd like to drop this.
*
* @author Kohsuke Kawaguchi
*/
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public @interface XmlIsSet {
/**
* Specifies the name of the property to attach to.
*/
String value();
}
</pre>
<div id="after_source_code">
<h2>Other Java examples (source code examples)</h2>
<p>Here is a short list of links related to this Java XmlIsSet.java source code file:</p>
<ul>
<li><a href="/java/jwarehouse"><img src="/images/scw/find.png" border="0"> The search page</a></li>
<li><a href="index.shtml"><img src="/images/scw/folder.png" border="0"> Other Java source code examples at this package level</a></li>
<li><a href="/java/jwarehouse/about.shtml"><img src="/images/scw/information.png" border="0"> Click here to learn more about this project</a></li>
</ul>
</div>
</td>
</tr>
</table>
</div>
</div>
<div style="padding-top: 1em; width: 310px; margin-left: auto; margin-right: auto; table {border-collapse: collapse; border: none;}; tr {border-collapse: collapse; border: none; text-align: center;};">
<table width="100%" cellspacing="0" cellpadding="0">
<tr>
<td colspan="2" style="border-collapse: collapse; border: none; text-align: center;};">
<em>... this post is sponsored by my books ...</em>
</td>
</tr>
<tr>
<td width="150" style="border-collapse: collapse; border: none; text-align: center;};">
<a href="https://kbhr.co/ckbk-v2"><img
src="/images/books/scala-cookbook-v2-cover-220h.jpg"
title="The Scala Cookbook, by Alvin Alexander" height="220" />
<br /><span style="opacity: 0.4;">#1 New Release!</span></a>
</td>
<td width="150" style="border-collapse: collapse; border: none; text-align: center; padding-left: 8px;">
<a href="http://kbhr.co/fps-book"><img
src="/images/books/functional-programming-simplified-small.jpg"
title="Functional Programming, Simplified, by Alvin Alexander"
height="220" />
<br /><span style="opacity: 0.4;">FP Best Seller</span></a>
</td>
</tr>
</table>
<p> </p>
</div>
<div id="whats_new">
<h2>new blog posts</h2>
<div id="whats_new_list">
<ul>
<li><a class="whats_new_link" href="/photos/als-oasis">Al's Oasis</a></li>
<li><a class="whats_new_link" href="/photos/window-poet">Window of the Poet (painting)</a></li>
<li><a class="whats_new_link" href="/personal/ezoic-ads-vs-google-adsense-2024">Ezoic ads vs Google AdSense (2024, website advertising revenue/partner)</a></li>
<br/>
<li><a class="whats_new_link" href="/misc/dream-vacation-for-meditator-meditation">A dream vacation for the meditator in your life</a></li>
<li><a class="whats_new_link" href="/scala/zio-http-netty-AnnotatedNoRouteToHostException-null-solution">ZIO HTTP: Netty AnnotatedNoRouteToHostException null solution</a></li>
<li><a class="whats_new_link" href="/misc/inside-shinzens-brain-how-zen-master-experiences-daily-life-world-enlightened">Inside Shinzen'''s Brain: How A Zen Master Experiences his Daily Life</a></li>
<br/>
<li><a class="whats_new_link" href="/misc/shinzen-young-meditating-daily-life-arising-disappearing-the-source-love">Shinzen Young on meditating in his daily life: arising, disappearing, and The Source, and love</a></li>
<li><a class="whats_new_link" href="/scala/zio-zlayer-very-simple-example-dependency-injection-services">ZIO ZLayer: A simple '''Hello, world''' example (dependency injection, services)</a></li>
<li><a class="whats_new_link" href="/misc/trying-find-way-love-everyone-in-world-dont-like-dark-night-soul">Trying to find a way to love everyone in a world ...</a></li>
<br/>
<br/>
</div>
</ul>
</div>
<p> </p>
<p align="center"><font color="#000000" size="2"
face="Verdana,Arial">Copyright 1998-2021 Alvin Alexander, alvinalexander.com<br/>
All Rights Reserved.<br/>
<br/>
A percentage of advertising revenue from<br/>
pages under the <a href="/java/jwarehouse">/java/jwarehouse</a>
URI on this website is<br/>
paid back to open source projects.</p>
<script>
shuffle(books);
var div = document.getElementById("leftcol");
var pre = '<div style="margin: 0; padding-right: 1.6em"><h2 align="center">favorite books</h2>';
var post = '</div>';
if (adblock) {
var str = books.slice(0,3).join(" ");
div.insertAdjacentHTML('beforeend', pre + str + post);
} else {
var str = books.slice(0,1).join(" ");
div.insertAdjacentHTML('beforeend', pre + str + post);
}
</script>
<p style="padding-bottom: 80px;"> </p>
</body>
]]> |