Google Git
Sign in
apache / juneau-website / 18ad42d5ca1cb4de70d65a31194ec42f473c629f / . / content / site / apidocs-9.0-B1 / org / apache / juneau / xml / annotation / XmlFormat.html
blob: db53d0e93291cb4f376bc8077dcde8d2f03b574d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XmlFormat (Apache Juneau 9.0.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XmlFormat (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfigAnnotation.SerializerApply.html" title="class in org.apache.juneau.xml.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/xml/annotation/XmlNs.html" title="annotation in org.apache.juneau.xml.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/xml/annotation/XmlFormat.html" target="_top">Frames</a></li>
<li><a href="XmlFormat.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.juneau.xml.annotation</div>
<h2 title="Enum XmlFormat" class="title">Enum XmlFormat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.xml.annotation.XmlFormat</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public enum <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.23">XmlFormat</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>&gt;</pre>
<div class="block">XML format to use when serializing a POJO.
<ul class='seealso'>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.XmlDetails'>Overview &gt; juneau-marshall &gt; XML Details</a>
<li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java'>Source</a>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ATTR">ATTR</a></span></code>
<div class="block">Render a bean property as an attribute instead of an element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ATTRS">ATTRS</a></span></code>
<div class="block">Render property as attributes instead of an element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#COLLAPSED">COLLAPSED</a></span></code>
<div class="block">Prevents collections and arrays from being enclosed in <xt>&lt;array&gt;</xt> elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">Normal formatting (default).</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ELEMENT">ELEMENT</a></span></code>
<div class="block">Render property as an element instead of an attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ELEMENTS">ELEMENTS</a></span></code>
<div class="block">Render property value directly as the contents of the element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#MIXED">MIXED</a></span></code>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ELEMENTS"><code>ELEMENTS</code></a> except primitive types (string/boolean/number/null for example) are not wrapped in elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#MIXED_PWS">MIXED_PWS</a></span></code>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#MIXED"><code>MIXED</code></a>, but whitespace in text nodes are not trimmed during parsing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#TEXT">TEXT</a></span></code>
<div class="block">Render property value as the text content of the element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#TEXT_PWS">TEXT_PWS</a></span></code>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#TEXT"><code>TEXT</code></a>, but whitespace in text node is not trimmed during parsing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#VOID">VOID</a></span></code>
<div class="block">Identifies a void element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#XMLTEXT">XMLTEXT</a></span></code>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#TEXT"><code>TEXT</code></a> except the content is expected to be fully-formed XML that will get serialized as-is.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#isOneOf-org.apache.juneau.xml.annotation.XmlFormat...-">isOneOf</a></span>(<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>...&nbsp;formats)</code>
<div class="block">Returns <jk>true</jk> if this format is one of those specified.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.34">DEFAULT</a></pre>
<div class="block">Normal formatting (default).
<p>
On a bean class, implies <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ELEMENTS"><code>ELEMENTS</code></a> meaning bean properties will be serialized as child elements by default.
<p>
On a bean property, implies <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ELEMENT"><code>ELEMENT</code></a> meaning the bean property will be serialized as a child element.</div>
</li>
</ul>
<a name="ATTR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTR</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.45">ATTR</a></pre>
<div class="block">Render a bean property as an attribute instead of an element.
<p>
Only applicable for bean properties, not bean classes.
<p>
Can only be applied to properties (methods/fields) of class types that can be convertible to <c>Strings</c>.</div>
</li>
</ul>
<a name="ATTRS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRS</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.59">ATTRS</a></pre>
<div class="block">Render property as attributes instead of an element.
<p>
On a bean class, implies bean properties will be serialized as attributes instead of child elements by default.
<p>
On bean properties, implies that the bean property value itself should be serialized as attributes on the bean
element.
The bean property data type must be of class type <c>Map&lt;Object,Object&gt;</c> where both
objects are convertible to <c>Strings</c>.</div>
</li>
</ul>
<a name="ELEMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELEMENT</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.70">ELEMENT</a></pre>
<div class="block">Render property as an element instead of an attribute.
<p>
Only applicable for bean properties, not bean classes.
<p>
Used to override the behavior of the <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ATTRS"><code>ATTRS</code></a> format applied to the bean class.</div>
</li>
</ul>
<a name="ELEMENTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELEMENTS</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.86">ELEMENTS</a></pre>
<div class="block">Render property value directly as the contents of the element.
<p>
On a bean class, implies that bean properties will be serialized as child elements.
Note that this is equivalent to <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#DEFAULT"><code>DEFAULT</code></a>.
<p>
Only applicable for objects of type array/Collection.
<p>
On a bean property, implies that the bean property value itself should be serialized as child elements of the
bean element.</div>
</li>
</ul>
<a name="MIXED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MIXED</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.100">MIXED</a></pre>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#ELEMENTS"><code>ELEMENTS</code></a> except primitive types (string/boolean/number/null for example) are not wrapped in elements.
<p>
Only applicable for bean properties, not bean classes.
<p>
Only applicable for objects of type array/Collection.
<p>
Use of this format may cause data type loss during parsing if the types cannot be inferred through reflection.</div>
</li>
</ul>
<a name="MIXED_PWS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MIXED_PWS</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.108">MIXED_PWS</a></pre>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#MIXED"><code>MIXED</code></a>, but whitespace in text nodes are not trimmed during parsing.
<p>
An example use is HTML5 <xt>&lt;pre&gt;</xt> where whitespace should not be discarded.</div>
</li>
</ul>
<a name="TEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.122">TEXT</a></pre>
<div class="block">Render property value as the text content of the element.
<p>
Similar to <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#MIXED"><code>MIXED</code></a> but value must be a single value, not a collection.
<p>
Only applicable for bean properties, not bean classes.
<p>
Use of this format may cause data type loss during parsing if the type cannot be inferred through reflection.</div>
</li>
</ul>
<a name="TEXT_PWS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_PWS</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.127">TEXT_PWS</a></pre>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#TEXT"><code>TEXT</code></a>, but whitespace in text node is not trimmed during parsing.</div>
</li>
</ul>
<a name="XMLTEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XMLTEXT</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.141">XMLTEXT</a></pre>
<div class="block">Same as <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html#TEXT"><code>TEXT</code></a> except the content is expected to be fully-formed XML that will get serialized as-is.
<p>
During parsing, this XML text will be re-serialized and set on the property.
<p>
Only applicable for bean properties, not bean classes.
<p>
Use of this format may cause data type loss during parsing if the type cannot be inferred through reflection.</div>
</li>
</ul>
<a name="COLLAPSED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COLLAPSED</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.149">COLLAPSED</a></pre>
<div class="block">Prevents collections and arrays from being enclosed in <xt>&lt;array&gt;</xt> elements.
<p>
Can only be applied to properties (methods/fields) of type collection or array, or collection classes.</div>
</li>
</ul>
<a name="VOID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VOID</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.165">VOID</a></pre>
<div class="block">Identifies a void element.
<p>
Only applicable for bean classes.
<p>
Identifies an element that never contains content.
<p>
The main difference in behavior is how non-void empty elements are handled in the HTML serializer.
Void elements are serialized as collapsed nodes (e.g. <js>"&lt;br/&gt;"</js>) whereas non-void empty elements are
serialized with an end tag (e.g. "&lt;p&gt;&lt;/p&gt;").</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.26">values</a>()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (XmlFormat c : XmlFormat.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.26">valueOf</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a name="isOneOf-org.apache.juneau.xml.annotation.XmlFormat...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isOneOf</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.173">isOneOf</a>(<a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>...&nbsp;formats)</pre>
<div class="block">Returns <jk>true</jk> if this format is one of those specified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>formats</code> - The formats to match against.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><jk>true</jk> if this format is one of those specified.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfigAnnotation.SerializerApply.html" title="class in org.apache.juneau.xml.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/xml/annotation/XmlNs.html" title="annotation in org.apache.juneau.xml.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/xml/annotation/XmlFormat.html" target="_top">Frames</a></li>
<li><a href="XmlFormat.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>