Google Git
Sign in
apache / juneau-website / a3f0a79525a7fc1635a58754dfc19095a04f4a0c / . / content / site / apidocs-9.0.0 / org / apache / juneau / uon / annotation / UonConfig.html
blob: 650f53e85f5e67011736a4747a2c62b02261a5c3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>UonConfig (Apache Juneau 9.0.0)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.juneau.uon.annotation, annotation type: UonConfig">
<meta name="generator" content="javadoc/AnnotationTypeWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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">
<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>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.juneau.uon.annotation</a></div>
<h1 title="Annotation Type UonConfig" class="title">Annotation Type UonConfig</h1>
</div>
<div class="contentContainer">
<section class="description">
<hr>
<pre>@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
<a href="../../annotation/ContextApply.html" title="annotation in org.apache.juneau.annotation">@ContextApply</a>({<a href="UonConfigAnnotation.SerializerApply.html" title="class in org.apache.juneau.uon.annotation">SerializerApply.class</a>,<a href="UonConfigAnnotation.ParserApply.html" title="class in org.apache.juneau.uon.annotation">ParserApply.class</a>})
public @interface <a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.35">UonConfig</a></pre>
<div class="block">Annotation for specifying config properties defined in <a href="../UonSerializer.html" title="class in org.apache.juneau.uon"><code>UonSerializer</code></a> and <a href="../UonParser.html" title="class in org.apache.juneau.uon"><code>UonParser</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.UonDetails">UON Details</a>
</ul></div>
</section>
<section class="summary">
<ul class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<li class="blockList">
<section class="memberSummary"><a id="annotation.type.optional.element.summary">
<!-- -->
</a>
<h2>Optional Element Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Optional Element</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addBeanTypes()">addBeanTypes</a></span></code></th>
<td class="colLast">
<div class="block">Add <js>"_type"</js> properties when needed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decoding()">decoding</a></span></code></th>
<td class="colLast">
<div class="block">Decode <js>"%xx"</js> sequences.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encoding()">encoding</a></span></code></th>
<td class="colLast">
<div class="block">Encode non-valid URI characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#paramFormat()">paramFormat</a></span></code></th>
<td class="colLast">
<div class="block">Format to use for query/form-data/header values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rank()">rank</a></span></code></th>
<td class="colLast">
<div class="block">Optional rank for this config.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateEnd()">validateEnd</a></span></code></th>
<td class="colLast">
<div class="block">Validate end.</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<li class="blockList">
<section class="memberDetails"><a id="annotation.type.element.detail">
<!-- -->
</a>
<h2>Element Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="rank()">rank</a></h3>
<div class="memberSignature"><span class="returnType">int</span>&nbsp;<span class="memberName"><a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.49">rank</a></span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="decoding()">decoding</a></h3>
<div class="memberSignature"><span class="returnType">java.lang.String</span>&nbsp;<span class="memberName"><a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.82">decoding</a></span></div>
<div class="block">Decode <js>"%xx"</js> sequences.
<p>
Specify <js>"true"</js> if URI encoded characters should be decoded, <js>"false"</js> if they've already been decoded
before being passed to this parser.
<ul class='values'>
<li><js>"true"</js> (default for <a href="../../urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingParser</code></a>)
<li><js>"false"</js> (default for <a href="../UonParser.html" title="class in org.apache.juneau.uon"><code>UonParser</code></a>)
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class="doclink" href="../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../UonParser.Builder.html#decoding()"><code>UonParser.Builder.decoding()</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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="validateEnd()">validateEnd</a></h3>
<div class="memberSignature"><span class="returnType">java.lang.String</span>&nbsp;<span class="memberName"><a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.107">validateEnd</a></span></div>
<div class="block">Validate end.
<p>
If <js>"true"</js>, after parsing a POJO from the input, verifies that the remaining input in
the stream consists of only comments or whitespace.
<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">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../UonParser.Builder.html#validateEnd()"><code>UonParser.Builder.validateEnd()</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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="addBeanTypes()">addBeanTypes</a></h3>
<div class="memberSignature"><span class="returnType">java.lang.String</span>&nbsp;<span class="memberName"><a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.140">addBeanTypes</a></span></div>
<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="../../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="../../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">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../UonSerializer.Builder.html#addBeanTypesUon()"><code>UonSerializer.Builder.addBeanTypesUon()</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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="encoding()">encoding</a></h3>
<div class="memberSignature"><span class="returnType">java.lang.String</span>&nbsp;<span class="memberName"><a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.169">encoding</a></span></div>
<div class="block">Encode non-valid URI characters.
<p>
Encode non-valid URI characters with <js>"%xx"</js> constructs.
<p>
If <js>"true"</js>, non-valid URI characters will be converted to <js>"%xx"</js> sequences.
<br>Set to <js>"false"</js> if parameter value is being passed to some other code that will already perform
URL-encoding of non-valid URI characters.
<ul class='values'>
<li><js>"true"</js> (default for <a href="../../urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingSerializer</code></a>)
<li><js>"false"</js> (default for <a href="../UonSerializer.html" title="class in org.apache.juneau.uon"><code>UonSerializer</code></a>)
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class="doclink" href="../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../UonSerializer.Builder.html#encoding()"><code>UonSerializer.Builder.encoding()</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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="paramFormat()">paramFormat</a></h3>
<div class="memberSignature"><span class="returnType">java.lang.String</span>&nbsp;<span class="memberName"><a href="../../../../../src-html/org/apache/juneau/uon/annotation/UonConfig.html#line.193">paramFormat</a></span></div>
<div class="block">Format to use for query/form-data/header values.
<p>
Specifies the format to use for URL GET parameter keys and values.
<ul class='values'>
<li><js>"UON"</js> (default) - Use UON notation for parameters.
<li><js>"PLAINTEXT"</js> - Use plain text for parameters.
</ul>
<ul class='notes'>
<li class='note'>
Supports <a class="doclink" href="../../../../../overview-summary.html#juneau-marshall.jm.SimpleVariableLanguage.jm.DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
</ul>
<ul class='seealso'>
<li class='jm'><a href="../UonSerializer.Builder.html#paramFormat(org.apache.juneau.uon.ParamFormat)"><code>UonSerializer.Builder.paramFormat(ParamFormat)</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>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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">
<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>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<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>
</footer>
</div>
</div>
</body>
</html>