blob: bb3f6dfe8afe503c0f18cca59a89373dbcee167b [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>ParameterFormat (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.parameter.ParameterFormat class">
<meta name="keywords" content="getValueType()">
<meta name="keywords" content="getLocale()">
<meta name="keywords" content="getContentLevel()">
<meta name="keywords" content="setContentLevel()">
<meta name="keywords" content="getPreferredCodespaces()">
<meta name="keywords" content="setPreferredCodespaces()">
<meta name="keywords" content="getColors()">
<meta name="keywords" content="setColors()">
<meta name="keywords" content="format()">
<meta name="keywords" content="parse()">
<meta name="keywords" content="clone()">
<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="ParameterFormat (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};
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/ParameterFormat.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>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.parameter</a></div>
<h2 title="Class ParameterFormat" class="title">Class ParameterFormat</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><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></li>
<li>
<ul class="inheritance">
<li><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a>&lt;<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>&gt;</li>
<li>
<ul class="inheritance">
<li>ParameterFormat</li>
</ul>
</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><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <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">ParameterFormat</span>
extends <a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a>&lt;<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>&gt;</pre>
<div class="block">Formats <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">parameter descriptors</a> or
<a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">parameter values</a> in a tabular format.
This format assumes a monospaced font and an encoding supporting drawing box
characters (e.g. UTF-8).
<p>This class can format parameters with different levels of verbosity, specified by the <a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter"><code>Parameter­Format​.Content­Level</code></a>
property. The content level controls whether the formatter should write all names and aliases (at the cost of
multi-line rows), or to pickup one name per parameter for a more compact table. See <a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter"><code>Parameter­Format​.Content­Level</code></a>
javadoc for output examples.</p>
<div class="note"><b>Example:</b>
The <cite>Mercator (variant A)</cite> example given in <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter"><code>Default­Parameter­Descriptor­Group</code></a> javadoc
will be formatted by default as below:
<blockquote><pre>EPSG: Mercator (variant A)
┌────────────────────────────────┬────────┬────────────┬───────────────┬───────────────┐
│ Name (EPSG) │ Type │ Obligation │ Value domain │ Default value │
├────────────────────────────────┼────────┼────────────┼───────────────┼───────────────┤
│ Latitude of natural origin │ Double │ Mandatory │ [-80 … 84]° │ 0.0° │
│ Longitude of natural origin │ Double │ Mandatory │ [-180 … 180]° │ 0.0° │
│ Scale factor at natural origin │ Double │ Mandatory │ (0 … ∞) │ 1.0 │
│ False easting │ Double │ Mandatory │ (−∞ … ∞) m │ 0.0 m │
│ False northing │ Double │ Mandatory │ (−∞ … ∞) m │ 0.0 m │
└────────────────────────────────┴────────┴────────────┴───────────────┴───────────────┘</pre></blockquote>
</div>
The kinds of objects accepted by this formatter are:
<table class="sis">
<caption>Formattable object types</caption>
<tr><th>Class</th> <th>Remarks</th></tr>
<tr><td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterValueGroup</code></a></td><td><cite>Default values</cite> column is replaced by a column of the actual values.</td></tr>
<tr><td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterDescriptorGroup</code></a></td><td>Table caption is the parameter group name.</td></tr>
<tr><td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/OperationMethod.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>OperationMethod</code></a></td><td>Table caption is the method name (not necessarily the same than parameter group name).</td></tr>
<tr><td><code><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>[]</code></td><td>Accepted only for <a href="ParameterFormat.ContentLevel.html#NAME_SUMMARY"><code>Parameter­Format​.Content­Level​.NAME_SUMMARY</code></a>.</td></tr>
</table>
<p><b>Limitations:</b></p>
<ul>
<li>The current implementation can only format features — parsing is not yet implemented.</li>
<li><code>Parameter­Format</code>, like most <code>java​.text​.Format</code> subclasses, is not thread-safe.</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="../../../../serialized-form.html#org.apache.sis.parameter.ParameterFormat">Serialized Form</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">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter">ParameterFormat.ContentLevel</a></span></code></th>
<td class="colLast">
<div class="block">The amount of information to include in the table formatted by <a href="ParameterFormat.html" title="class in org.apache.sis.parameter"><code>Parameter­Format</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.java.text.Format">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.Field.html?is-external=true" title="class or interface in java.text" class="externalLink">Format​.Field</a></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>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.TabularFormat">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;<a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a></h3>
<code><a href="../io/TabularFormat.html#beforeFill">before­Fill</a>, <a href="../io/TabularFormat.html#columnSeparator">column­Separator</a>, <a href="../io/TabularFormat.html#fillCharacter">fill­Character</a>, <a href="../io/TabularFormat.html#lineSeparator">line­Separator</a>, <a href="../io/TabularFormat.html#omitTrailingNulls">omit­Trailing­Nulls</a></code></li>
</ul>
</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">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()">ParameterFormat</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new formatter for the default locale and timezone.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Locale,java.util.TimeZone)">ParameterFormat</a></span>&#8203;(<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;locale,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util" class="externalLink">TimeZone</a>&nbsp;timezone)</code></th>
<td class="colLast">
<div class="block">Creates a new formatter for the given locale and timezone.</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><a href="ParameterFormat.html" title="class in org.apache.sis.parameter">ParameterFormat</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a clone of this format.</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="#format(java.lang.Object,java.lang.Appendable)">format</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;object,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a>&nbsp;toAppendTo)</code></th>
<td class="colLast">
<div class="block">Formats the given object to the given stream of buffer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../io/wkt/Colors.html" title="class in org.apache.sis.io.wkt">Colors</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColors()">getColors</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the colors for an output on X3.64 compatible terminal, or <code>null</code> if none.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter">ParameterFormat.ContentLevel</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContentLevel()">getContentLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the amount of information to put in the table.</div>
</td>
</tr>
<tr id="i4" 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(java.util.Locale.Category)">getLocale</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.Category.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale.Category</a>&nbsp;category)</code></th>
<td class="colLast">
<div class="block">Returns the locale for the given category.</div>
</td>
</tr>
<tr id="i5" 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="#getPreferredCodespaces()">getPreferredCodespaces</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the code spaces of names, aliases and identifiers to show, or <code>null</code> if there is no restriction.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueType()">getValueType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type of objects formatted by this class.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><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></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.lang.CharSequence,java.text.ParsePosition)">parse</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;text,
<a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParsePosition.html?is-external=true" title="class or interface in java.text" class="externalLink">ParsePosition</a>&nbsp;pos)</code></th>
<td class="colLast">
<div class="block">Not yet supported.</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="#setColors(org.apache.sis.io.wkt.Colors)">setColors</a></span>&#8203;(<a href="../io/wkt/Colors.html" title="class in org.apache.sis.io.wkt">Colors</a>&nbsp;colors)</code></th>
<td class="colLast">
<div class="block">Sets the colors for an output on X3.64 compatible terminal.</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="#setContentLevel(org.apache.sis.parameter.ParameterFormat.ContentLevel)">setContentLevel</a></span>&#8203;(<a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter">ParameterFormat.ContentLevel</a>&nbsp;level)</code></th>
<td class="colLast">
<div class="block">Sets the amount of information to put in the table.</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="#setPreferredCodespaces(java.lang.String...)">setPreferredCodespaces</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;codespaces)</code></th>
<td class="colLast">
<div class="block">Filters names, aliases and identifiers by their code spaces.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.TabularFormat">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="../io/TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a></h3>
<code><a href="../io/TabularFormat.html#getColumnSeparatorMatcher(java.lang.CharSequence)">get­Column­Separator­Matcher</a>, <a href="../io/TabularFormat.html#getColumnSeparatorPattern()">get­Column­Separator­Pattern</a>, <a href="../io/TabularFormat.html#getLineSeparator()">get­Line­Separator</a>, <a href="../io/TabularFormat.html#setColumnSeparatorPattern(java.lang.String)">set­Column­Separator­Pattern</a>, <a href="../io/TabularFormat.html#setLineSeparator(java.lang.String)">set­Line­Separator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.CompoundFormat">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a></h3>
<code><a href="../io/CompoundFormat.html#createFormat(java.lang.Class)">create­Format</a>, <a href="../io/CompoundFormat.html#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)">format</a>, <a href="../io/CompoundFormat.html#getFormat(java.lang.Class)">get­Format</a>, <a href="../io/CompoundFormat.html#getLocale()">get­Locale</a>, <a href="../io/CompoundFormat.html#getTimeZone()">get­Time­Zone</a>, <a href="../io/CompoundFormat.html#parseObject(java.lang.String)">parse­Object</a>, <a href="../io/CompoundFormat.html#parseObject(java.lang.String,java.text.ParsePosition)">parse­Object</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Format">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#format(java.lang.Object)" title="class or interface in java.text" class="externalLink">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#formatToCharacterIterator(java.lang.Object)" title="class or interface in java.text" class="externalLink">format­To­Character­Iterator</a></code></li>
</ul>
<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#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#toString()" title="class or interface in java.lang" class="externalLink">to­String</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>ParameterFormat</h4>
<pre>public&nbsp;ParameterFormat()</pre>
<div class="block">Creates a new formatter for the default locale and timezone.</div>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Locale,java.util.TimeZone)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParameterFormat</h4>
<pre>public&nbsp;ParameterFormat&#8203;(<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;locale,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util" class="externalLink">TimeZone</a>&nbsp;timezone)</pre>
<div class="block">Creates a new formatter for the given locale and timezone.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locale</code> - the locale, or <code>null</code> for <code>Locale​.ROOT</code>.</dd>
<dd><code>timezone</code> - the timezone, or <code>null</code> for UTC.</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="getValueType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre class="methodSignature">public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<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>&gt;&nbsp;getValueType()</pre>
<div class="block">Returns the type of objects formatted by this class. This method has to return <code>Object​.class</code>
since it is the only common parent to all object types accepted by this formatter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/CompoundFormat.html#getValueType()">get­Value­Type</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<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>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Object​.class</code></dd>
</dl>
</li>
</ul>
<a id="getLocale(java.util.Locale.Category)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocale</h4>
<pre class="methodSignature">public&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&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.Category.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale.Category</a>&nbsp;category)</pre>
<div class="block">Returns the locale for the given category.
<ul>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.Category.html?is-external=true#FORMAT" title="class or interface in java.util" class="externalLink"><code>Locale​.Category​.FORMAT</code></a> specifies the locale to use for values.</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.Category.html?is-external=true#DISPLAY" title="class or interface in java.util" class="externalLink"><code>Locale​.Category​.DISPLAY</code></a> specifies the locale to use for labels.</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../io/CompoundFormat.html#getLocale(java.util.Locale.Category)">get­Locale</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<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>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>category</code> - the category for which a locale is desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the locale for the given category (never <code>null</code>).</dd>
</dl>
</li>
</ul>
<a id="getContentLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentLevel</h4>
<pre class="methodSignature">public&nbsp;<a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter">ParameterFormat.ContentLevel</a>&nbsp;getContentLevel()</pre>
<div class="block">Returns the amount of information to put in the table.
The default value is <a href="ParameterFormat.ContentLevel.html#BRIEF"><code>Parameter­Format​.Content­Level​.BRIEF</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the table content.</dd>
</dl>
</li>
</ul>
<a id="setContentLevel(org.apache.sis.parameter.ParameterFormat.ContentLevel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContentLevel</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setContentLevel&#8203;(<a href="ParameterFormat.ContentLevel.html" title="enum in org.apache.sis.parameter">ParameterFormat.ContentLevel</a>&nbsp;level)</pre>
<div class="block">Sets the amount of information to put in the table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - the amount of information to put in the table.</dd>
</dl>
</li>
</ul>
<a id="getPreferredCodespaces()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreferredCodespaces</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;getPreferredCodespaces()</pre>
<div class="block">Returns the code spaces of names, aliases and identifiers to show, or <code>null</code> if there is no restriction.
This method returns the sequence specified by the last call to <a href="#setPreferredCodespaces(java.lang.String...)"><code>set­Preferred­Codespaces(String[])</code></a>,
without duplicated values.
<p>The default value is <code>null</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the code spaces of names and identifiers to show, or <code>null</code> if no restriction.</dd>
</dl>
</li>
</ul>
<a id="setPreferredCodespaces(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreferredCodespaces</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPreferredCodespaces&#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;codespaces)</pre>
<div class="block">Filters names, aliases and identifiers by their code spaces. If the given array is non-null, then the only names,
aliases and identifiers to be formatted are those having a <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true#getCodeSpace()" title="class or interface in org.opengis.referencing" class="externalLink"><code>Reference­Identifier​.get­Code­Space()</code></a>,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/ScopedName.html?is-external=true#head()" title="class or interface in org.opengis.util" class="externalLink"><code>Scoped­Name​.head()</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#scope()" title="class or interface in org.opengis.util" class="externalLink"><code>Generic­Name​.scope()</code></a> value in the given list, unless no name or alias
matches this criterion.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>codespaces</code> - the preferred code spaces of names, aliases and identifiers to format, or <code>null</code>
for accepting all of them. Some typical values are <code>"EPSG"</code>, <code>"OGC"</code> or <code>"Geo­TIFF"</code>.</dd>
</dl>
</li>
</ul>
<a id="getColors()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColors</h4>
<pre class="methodSignature">public&nbsp;<a href="../io/wkt/Colors.html" title="class in org.apache.sis.io.wkt">Colors</a>&nbsp;getColors()</pre>
<div class="block">Returns the colors for an output on X3.64 compatible terminal, or <code>null</code> if none.
The default value is <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the colors for an output on X3.64 compatible terminal, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="setColors(org.apache.sis.io.wkt.Colors)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColors</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setColors&#8203;(<a href="../io/wkt/Colors.html" title="class in org.apache.sis.io.wkt">Colors</a>&nbsp;colors)</pre>
<div class="block">Sets the colors for an output on X3.64 compatible terminal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>colors</code> - the colors for an output on X3.64 compatible terminal, or <code>null</code> if none.</dd>
</dl>
</li>
</ul>
<a id="format(java.lang.Object,java.lang.Appendable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;format&#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;object,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a>&nbsp;toAppendTo)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Formats the given object to the given stream of buffer.
The object may be an instance of any of the following types:
<ul>
<li><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>Parameter­Value­Group</code></a></li>
<li><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>Parameter­Descriptor­Group</code></a></li>
<li><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/OperationMethod.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Operation­Method</code></a></li>
<li><code><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">Identified­Object</a>[]</code> — accepted only for <a href="ParameterFormat.ContentLevel.html#NAME_SUMMARY"><code>Parameter­Format​.Content­Level​.NAME_SUMMARY</code></a>.</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/CompoundFormat.html#format(T,java.lang.Appendable)">format</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<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>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the object to format.</dd>
<dd><code>to­Append­To</code> - where to format the object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an error occurred while writing to the given appendable.</dd>
</dl>
</li>
</ul>
<a id="parse(java.lang.CharSequence,java.text.ParsePosition)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&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>&nbsp;parse&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>&nbsp;text,
<a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParsePosition.html?is-external=true" title="class or interface in java.text" class="externalLink">ParsePosition</a>&nbsp;pos)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text" class="externalLink">ParseException</a></pre>
<div class="block">Not yet supported.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/CompoundFormat.html#parse(java.lang.CharSequence,java.text.ParsePosition)">parse</a></code>&nbsp;in class&nbsp;<code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a>&lt;<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>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the character sequence for the object to parse.</dd>
<dd><code>pos</code> - the position where to start the parsing.
On return, the position where the parsing stopped or where an error occurred.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>currently never return.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text" class="externalLink">Parse­Exception</a></code> - currently always thrown.</dd>
</dl>
</li>
</ul>
<a id="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="ParameterFormat.html" title="class in org.apache.sis.parameter">ParameterFormat</a>&nbsp;clone()</pre>
<div class="block">Returns a clone of this format.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../io/TabularFormat.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="../io/TabularFormat.html" title="class in org.apache.sis.io">Tabular­Format</a>&lt;<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>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a clone of this format.</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/ParameterFormat.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>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>