blob: 89f59019b26b134e63070db5c05af253a327a8a0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Template (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Template (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":9,"i5":9,"i6":9,"i7":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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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="class-use/Template.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.util</a></div>
<h2 title="Class Template" class="title">Class Template</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.text.Format</li>
<li>
<ul class="inheritance">
<li>java.text.MessageFormat</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.util.Template</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Cloneable</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Template</span>
extends java.text.MessageFormat</pre>
<div class="block">String template.
<p>It is extended from <code>MessageFormat</code> to allow parameters
to be substituted by name as well as by position.
<p>The following example, using MessageFormat, yields "Happy 64th birthday,
Ringo!":
<blockquote>MessageFormat f =
new MessageFormat("Happy {0,number}th birthday, {1}!");<br>
Object[] args = {64, "Ringo"};<br>
System.out.println(f.format(args);</blockquote>
<p>Here is the same example using a Template and named parameters:
<blockquote>Template f =
new Template("Happy {age,number}th birthday, {name}!");<br>
Map&lt;Object, Object&gt; args = new HashMap&lt;Object, Object&gt;();<br>
args.put("age", 64);<br>
args.put("name", "Ringo");<br>
System.out.println(f.format(args);</blockquote>
<p>Using a Template you can also use positional parameters:
<blockquote>Template f =
new Template("Happy {age,number}th birthday, {name}!");<br>
Object[] args = {64, "Ringo"};<br>
System.out.println(f.format(args);</blockquote>
<p>Or a hybrid; here, one argument is specified by name, another by position:
<blockquote>Template f =
new Template("Happy {age,number}th birthday, {name}!");<br>
Map&lt;Object, Object&gt; args = new HashMap&lt;Object, Object&gt;();<br>
args.put(0, 64);<br>
args.put("name", "Ringo");<br>
System.out.println(f.format(args);</blockquote></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.calcite.util.Template">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.java.text.MessageFormat">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;java.text.MessageFormat</h3>
<code>java.text.MessageFormat.Field</code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parameterNames">parameterNames</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.util.List,java.util.Locale)">Template</a></span>&#8203;(java.lang.String&nbsp;pattern,
java.util.List&lt;java.lang.String&gt;&nbsp;parameterNames,
java.util.Locale&nbsp;locale)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(java.util.Map)">format</a></span>&#8203;(java.util.Map&lt;java.lang.Object,&#8203;java.lang.Object&gt;&nbsp;argMap)</code></th>
<td class="colLast">
<div class="block">Formats a set of arguments to produce a string.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatByName(java.lang.String,java.util.Map)">formatByName</a></span>&#8203;(java.lang.String&nbsp;pattern,
java.util.Map&lt;java.lang.Object,&#8203;java.lang.Object&gt;&nbsp;argMap)</code></th>
<td class="colLast">
<div class="block">Creates a Template with the given pattern and uses it
to format the given arguments.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>private java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArg(java.util.Map,int)">getArg</a></span>&#8203;(java.util.Map&lt;java.lang.Object,&#8203;java.lang.Object&gt;&nbsp;argMap,
int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Returns the value of the <code>ordinal</code>th argument.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterNames()">getParameterNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the names of the parameters, in the order that they appeared in
the template string.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>private static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeFormat(java.lang.StringBuilder%5B%5D,java.util.List)">makeFormat</a></span>&#8203;(java.lang.StringBuilder[]&nbsp;segments,
java.util.List&lt;java.lang.String&gt;&nbsp;parameterNames)</code></th>
<td class="colLast">
<div class="block">Called when a complete parameter has been seen.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="Template.html" title="class in org.apache.calcite.util">Template</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.lang.String)">of</a></span>&#8203;(java.lang.String&nbsp;pattern)</code></th>
<td class="colLast">
<div class="block">Creates a Template for the default locale and the
specified pattern.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="Template.html" title="class in org.apache.calcite.util">Template</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.lang.String,java.util.Locale)">of</a></span>&#8203;(java.lang.String&nbsp;pattern,
java.util.Locale&nbsp;locale)</code></th>
<td class="colLast">
<div class="block">Creates a Template for the specified locale and
pattern.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>private static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#process(java.lang.String,java.util.List)">process</a></span>&#8203;(java.lang.String&nbsp;pattern,
java.util.List&lt;java.lang.String&gt;&nbsp;parameterNames)</code></th>
<td class="colLast">
<div class="block">Parses the pattern, populates the parameter names, and returns the
pattern with parameter names converted to parameter ordinals.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.text.MessageFormat">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.text.MessageFormat</h3>
<code>applyPattern, clone, equals, format, format, format, formatToCharacterIterator, getFormats, getFormatsByArgumentIndex, getLocale, hashCode, parse, parse, parseObject, setFormat, setFormatByArgumentIndex, setFormats, setFormatsByArgumentIndex, setLocale, toPattern</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.text.Format">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.text.Format</h3>
<code>format, parseObject</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="parameterNames">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parameterNames</h4>
<pre>private final&nbsp;java.util.List&lt;java.lang.String&gt; parameterNames</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,java.util.List,java.util.Locale)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Template</h4>
<pre>private&nbsp;Template&#8203;(java.lang.String&nbsp;pattern,
java.util.List&lt;java.lang.String&gt;&nbsp;parameterNames,
java.util.Locale&nbsp;locale)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="of(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">public static&nbsp;<a href="Template.html" title="class in org.apache.calcite.util">Template</a>&nbsp;of&#8203;(java.lang.String&nbsp;pattern)</pre>
<div class="block">Creates a Template for the default locale and the
specified pattern.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the pattern for this message format</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the pattern is invalid</dd>
</dl>
</li>
</ul>
<a id="of(java.lang.String,java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">public static&nbsp;<a href="Template.html" title="class in org.apache.calcite.util">Template</a>&nbsp;of&#8203;(java.lang.String&nbsp;pattern,
java.util.Locale&nbsp;locale)</pre>
<div class="block">Creates a Template for the specified locale and
pattern.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the pattern for this message format</dd>
<dd><code>locale</code> - the locale for this message format</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the pattern is invalid</dd>
</dl>
</li>
</ul>
<a id="process(java.lang.String,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>process</h4>
<pre class="methodSignature">private static&nbsp;java.lang.String&nbsp;process&#8203;(java.lang.String&nbsp;pattern,
java.util.List&lt;java.lang.String&gt;&nbsp;parameterNames)</pre>
<div class="block">Parses the pattern, populates the parameter names, and returns the
pattern with parameter names converted to parameter ordinals.
<p>To ensure that the same parsing rules apply, this code is copied from
<code>MessageFormat.applyPattern(String)</code> but with different
actions when a parameter is recognized.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - Pattern</dd>
<dd><code>parameterNames</code> - Names of parameters (output)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Pattern with named parameters substituted with ordinals</dd>
</dl>
</li>
</ul>
<a id="makeFormat(java.lang.StringBuilder[],java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeFormat</h4>
<pre class="methodSignature">private static&nbsp;void&nbsp;makeFormat&#8203;(java.lang.StringBuilder[]&nbsp;segments,
java.util.List&lt;java.lang.String&gt;&nbsp;parameterNames)</pre>
<div class="block">Called when a complete parameter has been seen.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>segments</code> - Comma-separated segments of the parameter definition</dd>
<dd><code>parameterNames</code> - List of parameter names seen so far</dd>
</dl>
</li>
</ul>
<a id="format(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;format&#8203;(java.util.Map&lt;java.lang.Object,&#8203;java.lang.Object&gt;&nbsp;argMap)</pre>
<div class="block">Formats a set of arguments to produce a string.
<p>Arguments may appear in the map using named keys (of type String), or
positional keys (0-based ordinals represented either as type String or
Integer).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argMap</code> - A map containing the arguments as (key, value) pairs</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Formatted string.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Format cannot format the given
object</dd>
</dl>
</li>
</ul>
<a id="getArg(java.util.Map,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArg</h4>
<pre class="methodSignature">private&nbsp;java.lang.Object&nbsp;getArg&#8203;(java.util.Map&lt;java.lang.Object,&#8203;java.lang.Object&gt;&nbsp;argMap,
int&nbsp;ordinal)</pre>
<div class="block">Returns the value of the <code>ordinal</code>th argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argMap</code> - Map of argument values</dd>
<dd><code>ordinal</code> - Ordinal of argument</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Value of argument</dd>
</dl>
</li>
</ul>
<a id="formatByName(java.lang.String,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatByName</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;formatByName&#8203;(java.lang.String&nbsp;pattern,
java.util.Map&lt;java.lang.Object,&#8203;java.lang.Object&gt;&nbsp;argMap)</pre>
<div class="block">Creates a Template with the given pattern and uses it
to format the given arguments. This is equivalent to
<blockquote>
<code><a href="#of(java.lang.String)"><code>Template</code></a>(pattern).<a href="#format(java.util.Map)"><code>format(java.util.Map&lt;java.lang.Object, java.lang.Object&gt;)</code></a>(args)</code>
</blockquote></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the pattern is invalid,
or if an argument in the
<code>arguments</code> array is not of the
type expected by the format element(s)
that use it.</dd>
</dl>
</li>
</ul>
<a id="getParameterNames()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParameterNames</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getParameterNames()</pre>
<div class="block">Returns the names of the parameters, in the order that they appeared in
the template string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of parameter names</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="class-use/Template.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>