blob: 795b7c08ad54de87cc1414998a46780620b700ed [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>Formatter (Apache SIS 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2019-09-20">
<meta name="keywords" content="org.apache.sis.io.wkt.Formatter class">
<meta name="keywords" content="getConvention()">
<meta name="keywords" content="getTransliterator()">
<meta name="keywords" content="getNameAuthority()">
<meta name="keywords" content="getLocale()">
<meta name="keywords" content="newLine()">
<meta name="keywords" content="indent()">
<meta name="keywords" content="shortOrLong()">
<meta name="keywords" content="append()">
<meta name="keywords" content="appendAny()">
<meta name="keywords" content="delegateTo()">
<meta name="keywords" content="getEnclosingElement()">
<meta name="keywords" content="hasContextualUnit()">
<meta name="keywords" content="addContextualUnit()">
<meta name="keywords" content="restoreContextualUnit()">
<meta name="keywords" content="toContextualUnit()">
<meta name="keywords" content="isInvalidWKT()">
<meta name="keywords" content="setInvalidWKT()">
<meta name="keywords" content="toWKT()">
<meta name="keywords" content="toString()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.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="Formatter (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10};
var tabs = {65535:["t0","All 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 = false;
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/Formatter.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.sis.io.wkt</a></div>
<h2 title="Class Formatter" class="title">Class Formatter</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" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li>Formatter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Formatter</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></pre>
<div class="block">Provides support methods for formatting a <cite>Well Known Text</cite> (WKT).
<p><code>Formatter</code> instances are created by <a href="WKTFormat.html" title="class in org.apache.sis.io.wkt"><code>WKTFormat</code></a> and given to the
<a href="FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)"><code>Formattable­Object​.format­To(Formatter)</code></a> method of the object to format.
<code>Formatter</code> provides the following services:</p>
<ul>
<li>A series of <code>append(…)</code> methods to be invoked by the <code>format­To(Formatter)</code> implementations.</li>
<li>Contextual information. In particular, the <a href="#toContextualUnit(javax.measure.Unit)">contextual units</a> depend on
the <a href="#getEnclosingElement(int)">enclosing WKT element</a>.</li>
<li>A flag for declaring the object unformattable.</li>
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html">WKT 2 specification</a>,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html">Legacy WKT 1</a></dd>
<p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Formatter</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new formatter instance with the default configuration.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.io.wkt.Convention,org.apache.sis.io.wkt.Symbols,int)">Formatter</a></span>&#8203;(<a href="Convention.html" title="enum in org.apache.sis.io.wkt">Convention</a>&nbsp;convention,
<a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a>&nbsp;symbols,
int&nbsp;indentation)</code></th>
<td class="colLast">
<div class="block">Creates a new formatter instance with the specified convention, symbols and indentation.</div>
</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="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>&lt;Q extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Quantity</a>&lt;Q&gt;&gt;<br><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addContextualUnit(javax.measure.Unit)">addContextualUnit</a></span>&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Adds a unit to use for the next measurements of the quantity <code>Q</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(boolean)">append</a></span>&#8203;(boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Appends a boolean value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(double)">append</a></span>&#8203;(double&nbsp;number)</code></th>
<td class="colLast">
<div class="block">Appends an floating point value.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(long)">append</a></span>&#8203;(long&nbsp;number)</code></th>
<td class="colLast">
<div class="block">Appends an integer value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(java.lang.String,org.apache.sis.io.wkt.ElementKind)">append</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text,
<a href="ElementKind.html" title="enum in org.apache.sis.io.wkt">ElementKind</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Appends a character string between quotes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(java.util.Date)">append</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;date)</code></th>
<td class="colLast">
<div class="block">Appends a date.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(javax.measure.Unit)">append</a></span>&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;?&gt;&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Appends a unit in a <code>Unit[…]</code> element or one of the specialized elements.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.apache.sis.io.wkt.FormattableObject)">append</a></span>&#8203;(<a href="FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Appends the given <code>Formattable­Object</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.apache.sis.math.Vector%5B%5D,int...)">append</a></span>&#8203;(<a href="../../math/Vector.html" title="class in org.apache.sis.math">Vector</a>[]&nbsp;rows,
int...&nbsp;fractionDigits)</code></th>
<td class="colLast">
<div class="block">Appends rows of numbers.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.opengis.metadata.extent.GeographicBoundingBox,int)">append</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicBoundingBox.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicBoundingBox</a>&nbsp;bbox,
int&nbsp;fractionDigits)</code></th>
<td class="colLast">
<div class="block">Appends the given geographic bounding box in a <code>BBOX[…]</code> element.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.opengis.referencing.operation.MathTransform)">append</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;transform)</code></th>
<td class="colLast">
<div class="block">Appends the given math transform, typically (but not necessarily) in a <code>PARAM_MT[…]</code> element.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.opengis.util.CodeList)">append</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a>&lt;?&gt;&nbsp;code)</code></th>
<td class="colLast">
<div class="block">Appends an enumeration or code list value.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appendAny(java.lang.Object)">appendAny</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Appends an object or an array of objects.</div>
</td>
</tr>
<tr id="i13" 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" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delegateTo(java.lang.Object)">delegateTo</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Delegates the formatting to another <a href="FormattableObject.html" title="class in org.apache.sis.io.wkt"><code>Formattable­Object</code></a> implementation.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="Convention.html" title="enum in org.apache.sis.io.wkt">Convention</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConvention()">getConvention</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the convention to use for formatting the WKT.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnclosingElement(int)">getEnclosingElement</a></span>&#8203;(int&nbsp;depth)</code></th>
<td class="colLast">
<div class="block">Returns the enclosing WKT element, or <code>null</code> if element being formatted is the root.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocale()">getLocale</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the locale to use for localizing <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>International­String</code></a> instances.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNameAuthority()">getNameAuthority</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the preferred authority for choosing the projection and parameter names.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="Transliterator.html" title="class in org.apache.sis.io.wkt">Transliterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransliterator()">getTransliterator</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a mapper between Java character sequences and the characters to write in WKT.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasContextualUnit(int)">hasContextualUnit</a></span>&#8203;(int&nbsp;depth)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if the element at the given depth specified a contextual unit.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#indent(int)">indent</a></span>&#8203;(int&nbsp;amount)</code></th>
<td class="colLast">
<div class="block">Increases or decreases the indentation.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInvalidWKT()">isInvalidWKT</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if the WKT written by this formatter is not strictly compliant to the WKT specification.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newLine()">newLine</a></span>()</code></th>
<td class="colLast">
<div class="block">Request a line separator before the next element to format.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#restoreContextualUnit(javax.measure.Unit,javax.measure.Unit)">restoreContextualUnit</a></span>&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;?&gt;&nbsp;unit,
<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;?&gt;&nbsp;previous)</code></th>
<td class="colLast">
<div class="block">Restores the contextual unit to its previous state before the call to <a href="#addContextualUnit(javax.measure.Unit)"><code>add­Contextual­Unit(Unit)</code></a>.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInvalidWKT(java.lang.Class,java.lang.Exception)">setInvalidWKT</a></span>&#8203;(<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="externalLink">Class</a>&lt;?&gt;&nbsp;unformattable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;cause)</code></th>
<td class="colLast">
<div class="block">Marks the current WKT representation of the given class as not strictly compliant with the WKT specification.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInvalidWKT(org.opengis.referencing.IdentifiedObject,java.lang.Exception)">setInvalidWKT</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a>&nbsp;unformattable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;cause)</code></th>
<td class="colLast">
<div class="block">Marks the current WKT representation of the given object as not strictly compliant with the WKT specification.</div>
</td>
</tr>
<tr id="i26" 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" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shortOrLong(java.lang.String,java.lang.String)">shortOrLong</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;shortKeyword,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;longKeyword)</code></th>
<td class="colLast">
<div class="block">Selects a short or long keyword depending on the <a href="KeywordStyle.html" title="enum in org.apache.sis.io.wkt"><code>Keyword­Style</code></a> value.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>&lt;Q extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Quantity</a>&lt;Q&gt;&gt;<br><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toContextualUnit(javax.measure.Unit)">toContextualUnit</a></span>&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Returns the unit to use instead than the given one, or <code>unit</code> if there is no replacement.</div>
</td>
</tr>
<tr id="i28" 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" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a string representation of this formatter for debugging purpose.</div>
</td>
</tr>
<tr id="i29" 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" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toWKT()">toWKT</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the WKT formatted by this object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <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" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hash­Code</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" class="externalLink">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" class="externalLink">notify­All</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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Formatter</h4>
<pre>public&nbsp;Formatter()</pre>
<div class="block">Creates a new formatter instance with the default configuration.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sis.io.wkt.Convention,org.apache.sis.io.wkt.Symbols,int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Formatter</h4>
<pre>public&nbsp;Formatter&#8203;(<a href="Convention.html" title="enum in org.apache.sis.io.wkt">Convention</a>&nbsp;convention,
<a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a>&nbsp;symbols,
int&nbsp;indentation)</pre>
<div class="block">Creates a new formatter instance with the specified convention, symbols and indentation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>convention</code> - the convention to use.</dd>
<dd><code>symbols</code> - the symbols.</dd>
<dd><code>indentation</code> - the amount of spaces to use in indentation for WKT formatting,
or <a href="WKTFormat.html#SINGLE_LINE"><code>WKTFormat​.SINGLE_LINE</code></a> for formatting the whole WKT on a single line.</dd>
</dl>
</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="getConvention()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConvention</h4>
<pre class="methodSignature">public final&nbsp;<a href="Convention.html" title="enum in org.apache.sis.io.wkt">Convention</a>&nbsp;getConvention()</pre>
<div class="block">Returns the convention to use for formatting the WKT. The default is <a href="Convention.html#WKT2"><code>Convention​.WKT2</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the convention (never <code>null</code>).</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="WKTFormat.html#setConvention(org.apache.sis.io.wkt.Convention)"><code>WKTFormat​.set­Convention(Convention)</code></a>,
<a href="FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)"><code>Formattable­Object​.to­String(Convention)</code></a></dd>
</dl>
</li>
</ul>
<a id="getTransliterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransliterator</h4>
<pre class="methodSignature">public final&nbsp;<a href="Transliterator.html" title="class in org.apache.sis.io.wkt">Transliterator</a>&nbsp;getTransliterator()</pre>
<div class="block">Returns a mapper between Java character sequences and the characters to write in WKT.
The intent is to specify how to write characters that are not allowed in WKT strings
according ISO 19162 specification. Return values can be:
<ul>
<li><a href="Transliterator.html#DEFAULT"><code>Transliterator​.DEFAULT</code></a> for performing replacements like "é" → "e"
in all WKT elements except <code>REMARKS["…"]</code>.</li>
<li><a href="Transliterator.html#IDENTITY"><code>Transliterator​.IDENTITY</code></a> for preserving non-ASCII characters.</li>
<li>Any other user-supplied mapping.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the mapper between Java character sequences and the characters to write in WKT.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="WKTFormat.html#setTransliterator(org.apache.sis.io.wkt.Transliterator)"><code>WKTFormat​.set­Transliterator(Transliterator)</code></a></dd>
</dl>
</li>
</ul>
<a id="getNameAuthority()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameAuthority</h4>
<pre class="methodSignature">public final&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a>&nbsp;getNameAuthority()</pre>
<div class="block">Returns the preferred authority for choosing the projection and parameter names.
<p>The preferred authority can be set by the <a href="WKTFormat.html#setNameAuthority(org.opengis.metadata.citation.Citation)"><code>WKTFormat​.set­Name­Authority(Citation)</code></a> method.
This is not necessarily the authority who created the object to format.</p>
<div class="note"><b>Example:</b>
The EPSG name of the <code>EPSG:6326</code> datum is <cite>"World Geodetic System 1984"</cite>.
However if the preferred authority is OGC, then the formatted datum name will rather look like
<cite>"WGS84"</cite> (the exact string depends on the object aliases).</div></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authority for projection and parameter names.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="WKTFormat.html#getNameAuthority()"><code>WKTFormat​.get­Name­Authority()</code></a>,
<a href="../../referencing/IdentifiedObjects.html#getName(org.opengis.referencing.IdentifiedObject,org.opengis.metadata.citation.Citation)"><code>Identified­Objects​.get­Name(Identified­Object, Citation)</code></a></dd>
</dl>
</li>
</ul>
<a id="getLocale()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocale</h4>
<pre class="methodSignature">public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a>&nbsp;getLocale()</pre>
<div class="block">Returns the locale to use for localizing <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>International­String</code></a> instances.
This is <em>not</em> the locale for formatting dates and numbers.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../util/Localized.html#getLocale()">get­Locale</a></code>&nbsp;in interface&nbsp;<code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the locale to use for localizing international strings.</dd>
</dl>
</li>
</ul>
<a id="newLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newLine</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;newLine()</pre>
<div class="block">Request a line separator before the next element to format. Invoking this method before any
<code>append(…)</code> method call will cause the next element to appear on the next line.
<p>This method has no effect in any of the following cases:</p>
<ul>
<li>This method has already been invoked before the next <code>append(…)</code>.</li>
<li>The indentation is <a href="WKTFormat.html#SINGLE_LINE"><code>WKTFormat​.SINGLE_LINE</code></a>.</li>
</ul></div>
</li>
</ul>
<a id="indent(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indent</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;indent&#8203;(int&nbsp;amount)</pre>
<div class="block">Increases or decreases the indentation. A value of <code>+1</code> increases
the indentation by the amount of spaces specified at construction time,
and a value of <code>-1</code> reduces it by the same amount.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>amount</code> - +1 for increasing the indentation, or -1 for decreasing it, or 0 for no-op.</dd>
</dl>
</li>
</ul>
<a id="shortOrLong(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shortOrLong</h4>
<pre class="methodSignature">public&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" class="externalLink">String</a>&nbsp;shortOrLong&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;shortKeyword,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;longKeyword)</pre>
<div class="block">Selects a short or long keyword depending on the <a href="KeywordStyle.html" title="enum in org.apache.sis.io.wkt"><code>Keyword­Style</code></a> value.
This method can be used by <a href="FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)"><code>Formattable­Object​.format­To(Formatter)</code></a>
implementations for choosing the return value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>short­Keyword</code> - the keyword to return if the style is <a href="KeywordStyle.html#SHORT"><code>Keyword­Style​.SHORT</code></a>.</dd>
<dd><code>long­Keyword</code> - the keyword to return if the style is <a href="KeywordStyle.html#LONG"><code>Keyword­Style​.LONG</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the short or long keyword depending on the keyword style setting.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="WKTFormat.html#setKeywordStyle(org.apache.sis.io.wkt.KeywordStyle)"><code>WKTFormat​.set­Keyword­Style(Keyword­Style)</code></a></dd>
</dl>
</li>
</ul>
<a id="append(org.apache.sis.io.wkt.FormattableObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a>&nbsp;object)</pre>
<div class="block">Appends the given <code>Formattable­Object</code>.
This method performs the following steps:
<ul>
<li>Invoke <code>object.<a href="FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)">format­To</a>(this)</code>.</li>
<li>Prepend the keyword returned by the above method call (e.g. <code>"GEOCS"</code>).</li>
<li>If the given object is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>Identified­Object</code></a>, then append complementary information:</li>
</ul>
<blockquote><table class="sis">
<caption>Complementary WKT elements</caption>
<tr><th>WKT 2 element</th><th>WKT 1 element</th><th>For types</th></tr>
<tr><td><code>Anchor[…]</code></td> <td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a></td></tr>
<tr><td><code>Scope[…]</code></td> <td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceSystem</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Coordinate­Operation</code></a></td></tr>
<tr><td><code>Area[…]</code></td> <td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceSystem</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Coordinate­Operation</code></a></td></tr>
<tr><td><code>BBox[…]</code></td> <td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceSystem</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Coordinate­Operation</code></a></td></tr>
<tr><td><code>VerticalExtent[…]</code></td><td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceSystem</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Coordinate­Operation</code></a></td></tr>
<tr><td><code>TimeExtent[…]</code></td> <td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceSystem</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Coordinate­Operation</code></a></td></tr>
<tr><td><code>Id[…]</code></td><td><code>Authority[…]</code></td><td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>IdentifiedObject</code></a></td></tr>
<tr><td><code>Remarks[…]</code></td> <td></td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceSystem</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Coordinate­Operation</code></a></td></tr>
</table></blockquote></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the formattable object to append to the WKT, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="append(org.opengis.metadata.extent.GeographicBoundingBox,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicBoundingBox.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicBoundingBox</a>&nbsp;bbox,
int&nbsp;fractionDigits)</pre>
<div class="block">Appends the given geographic bounding box in a <code>BBOX[…]</code> element.
Longitude and latitude values will be formatted in decimal degrees.
Longitudes are relative to the Greenwich meridian, with values increasing toward East.
Latitudes values are increasing toward North.
<div class="section">Numerical precision</div>
The ISO 19162 standards recommends to format those values with only 2 decimal digits.
This is because <code>Geographic­Bounding­Box</code> does not specify the datum, so this box
is an approximated information only.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bbox</code> - the geographic bounding box to append to the WKT, or <code>null</code>.</dd>
<dd><code>fraction­Digits</code> - the number of fraction digits to use. The recommended value is 2.</dd>
</dl>
</li>
</ul>
<a id="append(org.opengis.referencing.operation.MathTransform)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;transform)</pre>
<div class="block">Appends the given math transform, typically (but not necessarily) in a <code>PARAM_MT[…]</code> element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transform</code> - the transform object to append to the WKT, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="append(java.lang.String,org.apache.sis.io.wkt.ElementKind)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text,
<a href="ElementKind.html" title="enum in org.apache.sis.io.wkt">ElementKind</a>&nbsp;type)</pre>
<div class="block">Appends a character string between quotes.
The <a href="Symbols.html#getSeparator()">element separator</a> will be written before the text if needed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the string to format to the WKT, or <code>null</code> if none.</dd>
<dd><code>type</code> - the key of the colors to apply if syntax coloring is enabled, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="append(org.opengis.util.CodeList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">CodeList</a>&lt;?&gt;&nbsp;code)</pre>
<div class="block">Appends an enumeration or code list value.
The <a href="Symbols.html#getSeparator()">element separator</a> will be written before the code list if needed.
<p>For the WKT 2 format, this method uses the <a href="../../util/iso/Types.html#getCodeName(org.opengis.util.CodeList)">ISO name if available</a>
(for example <code>"north­East"</code>).
For the WKT 1 format, this method uses the programmatic name instead (for example <code>"NORTH_EAST"</code>).</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>code</code> - the code list to append to the WKT, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="append(java.util.Date)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;date)</pre>
<div class="block">Appends a date.
The <a href="Symbols.html#getSeparator()">element separator</a> will be written before the date if needed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>date</code> - the date to append to the WKT, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="append(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(boolean&nbsp;value)</pre>
<div class="block">Appends a boolean value.
The <a href="Symbols.html#getSeparator()">element separator</a> will be written before the boolean if needed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the boolean to append to the WKT.</dd>
</dl>
</li>
</ul>
<a id="append(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(long&nbsp;number)</pre>
<div class="block">Appends an integer value.
The <a href="Symbols.html#getSeparator()">element separator</a> will be written before the number if needed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - the integer to append to the WKT.</dd>
</dl>
</li>
</ul>
<a id="append(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(double&nbsp;number)</pre>
<div class="block">Appends an floating point value.
The <a href="Symbols.html#getSeparator()">element separator</a> will be written before the number if needed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - the floating point value to append to the WKT.</dd>
</dl>
</li>
</ul>
<a id="append(org.apache.sis.math.Vector[],int...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="../../math/Vector.html" title="class in org.apache.sis.math">Vector</a>[]&nbsp;rows,
int...&nbsp;fractionDigits)</pre>
<div class="block">Appends rows of numbers. Each number is separated by a space, and each row is separated by a comma.
Rows usually have all the same length, but this is not mandatory.
This method can be used for formatting geometries or matrix.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rows</code> - the rows to append, or <code>null</code> if none.</dd>
<dd><code>fraction­Digits</code> - the number of fraction digits for each column in a row, or <code>null</code> for default.
A precision can be specified for each column because those columns are often different dimensions of
a Coordinate Reference System (CRS), each with their own units of measurement.
If a row contains more numbers than <code>fraction­Digits​.length</code>,
then the last value in this array is repeated for all remaining row numbers.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
</dl>
</li>
</ul>
<a id="append(javax.measure.Unit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;?&gt;&nbsp;unit)</pre>
<div class="block">Appends a unit in a <code>Unit[…]</code> element or one of the specialized elements. Specialized elements are
<code>Angle­Unit</code>, <code>Length­Unit</code>, <code>Scale­Unit</code>, <code>Parametric­Unit</code> and <code>Time­Unit</code>.
By <a href="KeywordStyle.html#DEFAULT">default</a>, specialized unit keywords are used with the
<a href="Convention.html#WKT2">WKT 2 convention</a>.
<div class="note"><b>Example:</b>
<code>append(Units​.KILOMETRE)</code> will append "<code>Length­Unit["km", 1000]</code>" to the WKT.</div></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unit</code> - the unit to append to the WKT, or <code>null</code> if none.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#35">WKT 2 specification §7.4</a></dd>
</dl>
</li>
</ul>
<a id="appendAny(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendAny</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;appendAny&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</pre>
<div class="block">Appends an object or an array of objects.
This method performs the following choices:
<ul>
<li>If the given value is <code>null</code>, then this method appends the "<code>null</code>" string (without quotes).</li>
<li>Otherwise if the given value is an array, then this method appends the opening sequence symbol, formats all
elements by invoking this method recursively, then appends the closing sequence symbol.</li>
<li>Otherwise if the value type is assignable to the argument type of one of the <code>append(…)</code> methods
in this class, then the formatting will be delegated to that method.</li>
<li>Otherwise the given value is appended as a quoted text with its <code>to­String()</code> representation.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value to append to the WKT, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="delegateTo(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delegateTo</h4>
<pre class="methodSignature">public&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" class="externalLink">String</a>&nbsp;delegateTo&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;other)
throws <a href="UnformattableObjectException.html" title="class in org.apache.sis.io.wkt">UnformattableObjectException</a></pre>
<div class="block">Delegates the formatting to another <a href="FormattableObject.html" title="class in org.apache.sis.io.wkt"><code>Formattable­Object</code></a> implementation.
Invoking this method is equivalent to first verifying the <code>other</code> class,
then delegating as below:
<blockquote><pre><font color="green">return</font> other.<b>formatTo</b>(<font color="green">this</font>);</pre></blockquote>
This method is useful for <code>Formattable­Object</code> which are wrapper around another object.
It allows to delegate the WKT formatting to the wrapped object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the object to format with this formatter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value returned by <a href="FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)"><code>Formattable­Object​.format­To(Formatter)</code></a>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="UnformattableObjectException.html" title="class in org.apache.sis.io.wkt">Unformattable­Object­Exception</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.5</dd>
</dl>
</li>
</ul>
<a id="getEnclosingElement(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnclosingElement</h4>
<pre class="methodSignature">public&nbsp;<a href="FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a>&nbsp;getEnclosingElement&#8203;(int&nbsp;depth)</pre>
<div class="block">Returns the enclosing WKT element, or <code>null</code> if element being formatted is the root.
This method can be invoked by child elements having some aspects that depend on the enclosing element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>depth</code> - 1 for the immediate parent, 2 for the parent of the parent, <i>etc.</i></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parent element at the given depth, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="hasContextualUnit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasContextualUnit</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasContextualUnit&#8203;(int&nbsp;depth)</pre>
<div class="block">Returns <code>true</code> if the element at the given depth specified a contextual unit.
This method returns <code>true</code> if the formattable object given by <code>get­Enclosing­Element(depth)</code>
has invoked <a href="#addContextualUnit(javax.measure.Unit)"><code>add­Contextual­Unit(Unit)</code></a> with a non-null unit at least once.
<div class="note"><b>Note:</b>
The main purpose of this method is to allow <code>AXIS[…]</code> elements to determine if they should
inherit the unit specified by the enclosing CRS, or if they should specify their unit explicitly.</div></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>depth</code> - 1 for the immediate parent, 2 for the parent of the parent, <i>etc.</i></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the parent element at the given depth has invoked <code>add­Contextual­Unit(…)</code> at least once.</dd>
</dl>
</li>
</ul>
<a id="addContextualUnit(javax.measure.Unit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContextualUnit</h4>
<pre class="methodSignature">public&nbsp;&lt;Q extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Quantity</a>&lt;Q&gt;&gt;&nbsp;<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;&nbsp;addContextualUnit&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;&nbsp;unit)</pre>
<div class="block">Adds a unit to use for the next measurements of the quantity <code>Q</code>. The given unit will apply to
all WKT elements containing a value of quantity <code>Q</code> without their own <code>UNIT[…]</code> element,
until the <a href="#restoreContextualUnit(javax.measure.Unit,javax.measure.Unit)"><code>restore­Contextual­Unit(Unit, Unit)</code></a> method is invoked.
<p>If the given unit is null, then this method does nothing and returns <code>null</code>.</p>
<div class="section">Special case</div>
If the WKT conventions are <code>WKT1_COMMON_UNITS</code>, then this method ignores the given unit
and returns <code>null</code>. See <a href="Convention.html#WKT1_COMMON_UNITS"><code>Convention​.WKT1_COMMON_UNITS</code></a> javadoc for more information.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>Q</code> - the unit quantity.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unit</code> - the contextual unit to add, or <code>null</code> if none.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the previous contextual unit for quantity <code>Q</code>, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="restoreContextualUnit(javax.measure.Unit,javax.measure.Unit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restoreContextualUnit</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;restoreContextualUnit&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;?&gt;&nbsp;unit,
<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;?&gt;&nbsp;previous)</pre>
<div class="block">Restores the contextual unit to its previous state before the call to <a href="#addContextualUnit(javax.measure.Unit)"><code>add­Contextual­Unit(Unit)</code></a>.
This method is used in the following pattern:
<blockquote><pre><font color="green">final</font> Unit&lt;?&gt; previous = formatter.<b>addContextualUnit</b>(unit);
<i><font color="gray">// ... format some WKT elements here.</font></i>
formatter.<b>restoreContextualUnit</b>(unit, previous);</pre></blockquote></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unit</code> - the value given in argument to <code>add­Contextual­Unit(unit)</code> (can be <code>null</code>).</dd>
<dd><code>previous</code> - the value returned by <code>add­Contextual­Unit(unit)</code> (can be <code>null</code>).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­State­Exception</a></code> - if this method has not been invoked in the pattern documented above.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
</dl>
</li>
</ul>
<a id="toContextualUnit(javax.measure.Unit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toContextualUnit</h4>
<pre class="methodSignature">public&nbsp;&lt;Q extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Quantity</a>&lt;Q&gt;&gt;&nbsp;<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;&nbsp;toContextualUnit&#8203;(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a>&lt;Q&gt;&nbsp;unit)</pre>
<div class="block">Returns the unit to use instead than the given one, or <code>unit</code> if there is no replacement.
This method searches for a unit specified by <a href="#addContextualUnit(javax.measure.Unit)"><code>add­Contextual­Unit(Unit)</code></a>
which <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true#isCompatible(javax.measure.Unit)" title="class or interface in javax.measure" class="externalLink">is compatible</a> with the given unit.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>Q</code> - the quantity of the unit.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unit</code> - the unit to replace by the contextual unit, or <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a contextual unit compatible with the given unit, or <code>unit</code>
(which may be null) if no contextual unit has been found.</dd>
</dl>
</li>
</ul>
<a id="isInvalidWKT()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInvalidWKT</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isInvalidWKT()</pre>
<div class="block">Returns <code>true</code> if the WKT written by this formatter is not strictly compliant to the WKT specification.
This method returns <code>true</code> if <a href="#setInvalidWKT(org.opengis.referencing.IdentifiedObject,java.lang.Exception)"><code>set­Invalid­WKT(Identified­Object, Exception)</code></a> has been invoked at
least once. The action to take regarding invalid WKT is caller-dependent.
For example <a href="FormattableObject.html#toString()"><code>Formattable­Object​.to­String()</code></a> will accepts loose WKT formatting and ignore
this flag, while <a href="FormattableObject.html#toWKT()"><code>Formattable­Object​.to­WKT()</code></a> requires strict WKT formatting and will
thrown an exception if this flag is set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the WKT is invalid.</dd>
</dl>
</li>
</ul>
<a id="setInvalidWKT(org.opengis.referencing.IdentifiedObject,java.lang.Exception)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInvalidWKT</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setInvalidWKT&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a>&nbsp;unformattable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;cause)</pre>
<div class="block">Marks the current WKT representation of the given object as not strictly compliant with the WKT specification.
This method can be invoked by implementations of <a href="FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)"><code>Formattable­Object​.format­To(Formatter)</code></a> when the object
to format is more complex than what the WKT specification allows.
Applications can test <a href="#isInvalidWKT()"><code>is­Invalid­WKT()</code></a> later for checking WKT validity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unformattable</code> - the object that can not be formatted,</dd>
<dd><code>cause</code> - the cause for the failure to format, or <code>null</code> if the cause is not an exception.</dd>
</dl>
</li>
</ul>
<a id="setInvalidWKT(java.lang.Class,java.lang.Exception)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInvalidWKT</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setInvalidWKT&#8203;(<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="externalLink">Class</a>&lt;?&gt;&nbsp;unformattable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;cause)</pre>
<div class="block">Marks the current WKT representation of the given class as not strictly compliant with the WKT specification.
This method can be used as an alternative to <a href="#setInvalidWKT(org.opengis.referencing.IdentifiedObject,java.lang.Exception)"><code>set­Invalid­WKT(Identified­Object, Exception)</code></a> when the
problematic object is not an instance of <code>Identified­Object</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unformattable</code> - the class of the object that can not be formatted,</dd>
<dd><code>cause</code> - the cause for the failure to format, or <code>null</code> if the cause is not an exception.</dd>
</dl>
</li>
</ul>
<a id="toWKT()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toWKT</h4>
<pre class="methodSignature">public&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" class="externalLink">String</a>&nbsp;toWKT()</pre>
<div class="block">Returns the WKT formatted by this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the WKT formatted by this formatter.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&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" class="externalLink">String</a>&nbsp;toString()</pre>
<div class="block">Returns a string representation of this formatter for debugging purpose.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">to­String</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of this formatter.</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/Formatter.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>