Google Git
Sign in
apache / juneau-website / 18ad42d5ca1cb4de70d65a31194ec42f473c629f / . / content / site / apidocs-9.0-B1 / org / apache / juneau / xml / annotation / XmlConfig.html
blob: 752182d9f923cc8a245a802e2ad6ddf716f78b05 [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>XmlConfig (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="XmlConfig (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
</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/XmlAnnotation.Builder.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/XmlConfigAnnotation.html" title="class 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/XmlConfig.html" target="_top">Frames</a></li>
<li><a href="XmlConfig.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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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="Annotation Type XmlConfig" class="title">Annotation Type XmlConfig</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>})
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a>
<a href="../../../../../org/apache/juneau/annotation/ContextApply.html" title="annotation in org.apache.juneau.annotation">@ContextApply</a>(<a href="../../../../../org/apache/juneau/annotation/ContextApply.html#value--">value</a>={<a href="../../../../../org/apache/juneau/xml/annotation/XmlConfigAnnotation.SerializerApply.html" title="class in org.apache.juneau.xml.annotation">XmlConfigAnnotation.SerializerApply.class</a>,<a href="../../../../../org/apache/juneau/xml/annotation/XmlConfigAnnotation.ParserApply.html" title="class in org.apache.juneau.xml.annotation">XmlConfigAnnotation.ParserApply.class</a>})
public @interface <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.43">XmlConfig</a></pre>
<div class="block">Annotation for specifying config properties defined in <a href="../../../../../org/apache/juneau/xml/XmlSerializer.html" title="class in org.apache.juneau.xml"><code>XmlSerializer</code></a>, <a href="../../../../../org/apache/juneau/xml/XmlDocSerializer.html" title="class in org.apache.juneau.xml"><code>XmlDocSerializer</code></a>, and <a href="../../../../../org/apache/juneau/xml/XmlParser.html" title="class in org.apache.juneau.xml"><code>XmlParser</code></a>.
<p>
Used primarily for specifying bean configuration properties on REST classes and methods.
<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/XmlConfig.java'>Source</a>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#addBeanTypes--">addBeanTypes</a></span></code>
<div class="block">Add <js>"_type"</js> properties when needed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#addNamespaceUrisToRoot--">addNamespaceUrisToRoot</a></span></code>
<div class="block">Add namespace URLs to the root element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#defaultNamespace--">defaultNamespace</a></span></code>
<div class="block">Default namespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#disableAutoDetectNamespaces--">disableAutoDetectNamespaces</a></span></code>
<div class="block">Don't auto-detect namespace usage.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#enableNamespaces--">enableNamespaces</a></span></code>
<div class="block">Enable support for XML namespaces.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/util/XMLEventAllocator.html?is-external=true" title="class or interface in javax.xml.stream.util">XMLEventAllocator</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#eventAllocator--">eventAllocator</a></span></code>
<div class="block">XML event allocator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#namespaces--">namespaces</a></span></code>
<div class="block">Default namespaces.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#preserveRootElement--">preserveRootElement</a></span></code>
<div class="block">Preserve root element during generalized parsing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#rank--">rank</a></span></code>
<div class="block">Optional rank for this config.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLReporter.html?is-external=true" title="class or interface in javax.xml.stream">XMLReporter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#reporter--">reporter</a></span></code>
<div class="block">XML reporter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLResolver.html?is-external=true" title="class or interface in javax.xml.stream">XMLResolver</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#resolver--">resolver</a></span></code>
<div class="block">XML resolver.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html#validating--">validating</a></span></code>
<div class="block">Enable validation.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="rank--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rank</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.53">rank</a></pre>
<div class="block">Optional rank for this config.
<p>
Can be used to override default ordering and application of config annotations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="eventAllocator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eventAllocator</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/util/XMLEventAllocator.html?is-external=true" title="class or interface in javax.xml.stream.util">XMLEventAllocator</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.75">eventAllocator</a></pre>
<div class="block">XML event allocator.
<p>
Associates an <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/util/XMLEventAllocator.html?is-external=true" title="class or interface in javax.xml.stream.util"><code>XMLEventAllocator</code></a> with this parser.
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlParser.Builder.html#eventAllocator-java.lang.Class-"><code>XmlParser.Builder.eventAllocator(Class)</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.apache.juneau.xml.XmlEventAllocator.Void.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="preserveRootElement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preserveRootElement</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.100">preserveRootElement</a></pre>
<div class="block">Preserve root element during generalized parsing.
<p>
If <js>"true"</js>, when parsing into a generic <a href="../../../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections"><code>JsonMap</code></a>, the map will contain a single entry whose key
is the root element name.
<ul class='values'>
<li><js>"true"</js>
<li><js>"false"</js> (default)
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlParser.Builder.html#preserveRootElement--"><code>XmlParser.Builder.preserveRootElement()</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="reporter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reporter</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLReporter.html?is-external=true" title="class or interface in javax.xml.stream">XMLReporter</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.119">reporter</a></pre>
<div class="block">XML reporter.
<p>
Associates an <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLReporter.html?is-external=true" title="class or interface in javax.xml.stream"><code>XMLReporter</code></a> with this parser.
<ul class='notes'>
<li class='note'>
Reporters are not copied to new parsers during a clone.
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlParser.Builder.html#reporter-java.lang.Class-"><code>XmlParser.Builder.reporter(Class)</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.apache.juneau.xml.XmlReporter.Void.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="resolver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolver</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLResolver.html?is-external=true" title="class or interface in javax.xml.stream">XMLResolver</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.133">resolver</a></pre>
<div class="block">XML resolver.
<p>
Associates an <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLResolver.html?is-external=true" title="class or interface in javax.xml.stream"><code>XMLResolver</code></a> with this parser.
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlParser.Builder.html#resolver-java.lang.Class-"><code>XmlParser.Builder.resolver(Class)</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.apache.juneau.xml.XmlResolver.Void.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="validating--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validating</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.160">validating</a></pre>
<div class="block">Enable validation.
<p>
If <js>"true"</js>, XML document will be validated.
<p>
See <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLInputFactory.html?is-external=true#IS_VALIDATING" title="class or interface in javax.xml.stream"><code>XMLInputFactory.IS_VALIDATING</code></a> for more info.
<ul class='values'>
<li><js>"true"</js>
<li><js>"false"</js> (default)
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlParser.Builder.html#validating--"><code>XmlParser.Builder.validating()</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="addBeanTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBeanTypes</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.193">addBeanTypes</a></pre>
<div class="block">Add <js>"_type"</js> properties when needed.
<p>
If <js>"true"</js>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
through reflection.
<p>
When present, this value overrides the <a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#addBeanTypes--"><code>Serializer.Builder.addBeanTypes()</code></a> setting and is
provided to customize the behavior of specific serializers in a <a href="../../../../../org/apache/juneau/serializer/SerializerSet.html" title="class in org.apache.juneau.serializer"><code>SerializerSet</code></a>.
<ul class='values'>
<li><js>"true"</js>
<li><js>"false"</js> (default)
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#addBeanTypesXml--"><code>XmlSerializer.Builder.addBeanTypesXml()</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="addNamespaceUrisToRoot--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNamespaceUrisToRoot</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.220">addNamespaceUrisToRoot</a></pre>
<div class="block">Add namespace URLs to the root element.
<p>
Use this setting to add <code>xmlns:x</code> attributes to the root element for the default and all mapped namespaces.
<ul class='values'>
<li><js>"true"</js>
<li><js>"false"</js> (default)
</ul>
<ul class='notes'>
<li class='note'>
This setting is ignored if <a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#enableNamespaces--"><code>XmlSerializer.Builder.enableNamespaces()</code></a> is not enabled.
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#addNamespaceUrisToRoot--"><code>XmlSerializer.Builder.addNamespaceUrisToRoot()</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.XmlDetails.jm.XmlNamespaces'>Overview &gt; juneau-marshall &gt; XML Details &gt; Namespaces</a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="disableAutoDetectNamespaces--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableAutoDetectNamespaces</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.260">disableAutoDetectNamespaces</a></pre>
<div class="block">Don't auto-detect namespace usage.
<p>
Don't detect namespace usage before serialization.
<p>
Used in conjunction with <a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#addNamespaceUrisToRoot--"><code>XmlSerializer.Builder.addNamespaceUrisToRoot()</code></a> to reduce the list of namespace URLs appended to the
root element to only those that will be used in the resulting document.
<p>
If disabled, then the data structure will first be crawled looking for namespaces that will be encountered before
the root element is serialized.
<p>
This setting is ignored if <a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#enableNamespaces--"><code>XmlSerializer.Builder.enableNamespaces()</code></a> is not enabled.
<ul class='values'>
<li><js>"true"</js>
<li><js>"false"</js> (default)
</ul>
<ul class='notes'>
<li class='warn'>
Auto-detection of namespaces can be costly performance-wise.
<br>In high-performance environments, it's recommended that namespace detection be
disabled, and that namespaces be manually defined through the <a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#namespaces-org.apache.juneau.xml.Namespace...-"><code>XmlSerializer.Builder.namespaces(Namespace...)</code></a> property.
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#disableAutoDetectNamespaces--"><code>XmlSerializer.Builder.disableAutoDetectNamespaces()</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.XmlDetails.jm.XmlNamespaces'>Overview &gt; juneau-marshall &gt; XML Details &gt; Namespaces</a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultNamespace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultNamespace</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.280">defaultNamespace</a></pre>
<div class="block">Default namespace.
<p>
Specifies the default namespace URI for this document.
<ul class='notes'>
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#defaultNamespace-org.apache.juneau.xml.Namespace-"><code>XmlSerializer.Builder.defaultNamespace(Namespace)</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.XmlDetails.jm.XmlNamespaces'>Overview &gt; juneau-marshall &gt; XML Details &gt; Namespaces</a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="enableNamespaces--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableNamespaces</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.305">enableNamespaces</a></pre>
<div class="block">Enable support for XML namespaces.
<p>
If not enabled, XML output will not contain any namespaces regardless of any other settings.
<ul class='values'>
<li><js>"true"</js>
<li><js>"false"</js> (default)
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#enableNamespaces--"><code>XmlSerializer.Builder.enableNamespaces()</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.XmlDetails.jm.XmlNamespaces'>Overview &gt; juneau-marshall &gt; XML Details &gt; Namespaces</a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="namespaces--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>namespaces</h4>
<pre>public abstract&nbsp;<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;<a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlConfig.html#line.325">namespaces</a></pre>
<div class="block">Default namespaces.
<p>
The default list of namespaces associated with this serializer.
<ul class='notes'>
<li class='note'>
Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver'>Overview &gt; juneau-marshall &gt; Simple Variable Language &gt; VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/xml/XmlSerializer.Builder.html#namespaces-org.apache.juneau.xml.Namespace...-"><code>XmlSerializer.Builder.namespaces(Namespace...)</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.XmlDetails.jm.XmlNamespaces'>Overview &gt; juneau-marshall &gt; XML Details &gt; Namespaces</a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The annotation value.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</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/XmlAnnotation.Builder.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/XmlConfigAnnotation.html" title="class 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/XmlConfig.html" target="_top">Frames</a></li>
<li><a href="XmlConfig.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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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>