| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>Parameters (Apache SIS 1.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.sis.parameter, class: Parameters"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.parameter.Parameters class"> |
| <meta name="keywords" content="isUnmodifiable()"> |
| <meta name="keywords" content="unmodifiable()"> |
| <meta name="keywords" content="castOrWrap()"> |
| <meta name="keywords" content="cast()"> |
| <meta name="keywords" content="getDescriptors()"> |
| <meta name="keywords" content="getMemberName()"> |
| <meta name="keywords" content="getValueDomain()"> |
| <meta name="keywords" content="getValue()"> |
| <meta name="keywords" content="getMandatoryValue()"> |
| <meta name="keywords" content="booleanValue()"> |
| <meta name="keywords" content="intValue()"> |
| <meta name="keywords" content="intValueList()"> |
| <meta name="keywords" content="doubleValue()"> |
| <meta name="keywords" content="doubleValueList()"> |
| <meta name="keywords" content="stringValue()"> |
| <meta name="keywords" content="getOrCreate()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="copy()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="print()"> |
| <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="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Parameters.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.parameter</a></div> |
| <h1 title="Class Parameters" class="title">Class Parameters</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance">Parameters</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterValue</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../referencing/operation/transform/ContextualParameters.html" title="class in org.apache.sis.referencing.operation.transform">ContextualParameters</a></code>, <code><a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">DefaultParameterValueGroup</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Parameters</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></span></div> |
| <div class="block">Convenience methods for fetching parameter values despite the variations in parameter names, value types and units. |
| See <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter"><code>DefaultParameterValueGroup</code></a> javadoc for a description of the standard way to get and set a particular |
| parameter in a group. The remaining of this javadoc is specific to Apache SIS. |
| |
| <h2>Convenience methods</h2> |
| This class provides the following convenience static methods: |
| <ul> |
| <li><a href="#cast(org.opengis.parameter.ParameterValue,java.lang.Class)"><code>cast(…, Class)</code></a> for type safety with parameterized types.</li> |
| <li><a href="#getMemberName(org.opengis.parameter.ParameterDescriptor)"><code>getMemberName(ParameterDescriptor)</code></a> for inter-operability between ISO 19111 and ISO 19115.</li> |
| <li><a href="#getValueDomain(org.opengis.parameter.ParameterDescriptor)"><code>getValueDomain(ParameterDescriptor)</code></a> for information purpose.</li> |
| <li><a href="#copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)"><code>copy(ParameterValueGroup, ParameterValueGroup)</code></a> for copying values into an existing instance.</li> |
| </ul> |
| |
| Most instance methods in this class follow the same naming pattern |
| than the methods provided by the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValue</code></a> interface. |
| Those methods are themselves inspired by JDK methods: |
| |
| <table class="sis"> |
| <caption>Methods fetching parameter value</caption> |
| <tr><th><code>Parameters</code> method</th> <th><code>ParameterValue</code> method</th> <th>JDK methods</th></tr> |
| <tr><td><a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#getValue()"><code>getValue()</code></a></td> <td></td></tr> |
| <tr><td><a href="#booleanValue(org.opengis.parameter.ParameterDescriptor)"><code>booleanValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#booleanValue()"><code>booleanValue()</code></a></td> <td><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html#booleanValue()" title="class or interface in java.lang" class="external-link"><code>Boolean.booleanValue()</code></a></td></tr> |
| <tr><td><a href="#intValue(org.opengis.parameter.ParameterDescriptor)"><code>intValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#intValue()"><code>intValue()</code></a></td> <td><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html#intValue()" title="class or interface in java.lang" class="external-link"><code>Number.intValue()</code></a></td></tr> |
| <tr><td><a href="#intValueList(org.opengis.parameter.ParameterDescriptor)"><code>intValueList(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#intValueList()"><code>intValueList()</code></a></td> <td></td></tr> |
| <tr><td><a href="#doubleValue(org.opengis.parameter.ParameterDescriptor)"><code>doubleValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#doubleValue()"><code>doubleValue()</code></a></td> <td><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html#doubleValue()" title="class or interface in java.lang" class="external-link"><code>Number.doubleValue()</code></a></td></tr> |
| <tr><td><a href="#doubleValueList(org.opengis.parameter.ParameterDescriptor)"><code>doubleValueList(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#doubleValueList()"><code>doubleValueList()</code></a></td> <td></td></tr> |
| <tr><td><a href="#stringValue(org.opengis.parameter.ParameterDescriptor)"><code>stringValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#stringValue()"><code>stringValue()</code></a></td> <td></td></tr> |
| </table> |
| |
| |
| <h2>Fetching parameter values despite different names, types or units</h2> |
| The common way to get a parameter is to invoke the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#parameter(java.lang.String)" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValueGroup.parameter(String)</code></a> method. |
| This <code>Parameters</code> class provides alternative ways, using a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterDescriptor</code></a> argument |
| instead of a <code>String</code> argument. Those descriptors provide additional information like the various |
| <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">aliases</a> under which the same parameter may be known. |
| By using this information, <code>Parameters</code> can choose the most appropriate parameter name or alias |
| (by searching for a common <a href="../referencing/ImmutableIdentifier.html#getAuthority()">authority</a>) |
| when it delegates its work to the <code>parameter(String)</code> method. |
| |
| <div class="note"><b>Example:</b> |
| The same parameter may be known under different names. For example, the |
| <a href="../referencing/datum/DefaultEllipsoid.html#getSemiMajorAxis()">length of the semi-major axis of the ellipsoid</a> is commonly known as <code>"semi_major"</code>. |
| But that parameter can also be named <code>"semi_major_axis"</code>, <code>"earth_radius"</code> or simply <code>"a"</code> |
| in other libraries. When fetching parameter values, we do not always know in advance which of the above-cited |
| names is recognized by an arbitrary <code>ParameterValueGroup</code> instance.</div> |
| |
| <code>Parameters</code> uses also the descriptor information for applying type and unit conversions |
| (i.e. returned values are converted to the units of measurement specified by the given parameter descriptor). |
| |
| |
| <h2>Note for subclass implementers</h2> |
| This class does not implement any method from the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValueGroup</code></a> interface |
| (this class is not named “<code>AbstractParameterValueGroup</code>” for that reason). |
| Extending this class or extending <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link"><code>Object</code></a> make almost no difference for implementers; |
| <code>Parameters</code> purpose is mostly to extend the API for users convenience. |
| All methods in this class get their information from the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValueGroup</code></a> methods. |
| In addition, unless otherwise specified, methods in this class is isolated from all others: |
| overriding one method has no impact on other methods.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Parameters</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">For subclass constructors only.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#booleanValue(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">booleanValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the boolean value of the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#cast(org.opengis.parameter.ParameterDescriptor,java.lang.Class)" class="member-name-link">cast</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?> descriptor, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> valueClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Casts the given parameter descriptor to the given type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#cast(org.opengis.parameter.ParameterValue,java.lang.Class)" class="member-name-link">cast</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><?> parameter, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> valueClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Casts the given parameter value to the given type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#castOrWrap(org.opengis.parameter.ParameterValueGroup)" class="member-name-link">castOrWrap</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the given parameter value group as a <code>Parameters</code> instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a copy of this group of parameter values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)" class="member-name-link">copy</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> values, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> destination)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Copies the values of a parameter group into another parameter group.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doubleValue(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">doubleValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the floating point value of the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doubleValue(org.opengis.parameter.ParameterDescriptor,javax.measure.Unit)" class="member-name-link">doubleValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> parameter, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a><?> unit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the floating point value of the parameter identified by the given descriptor, |
| converted to the given unit of measurement.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doubleValueList(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">doubleValueList</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><double[]> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the floating point values of the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDescriptors(org.opengis.parameter.GeneralParameterValue...)" class="member-name-link">getDescriptors</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterValue</a>... parameters)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the descriptors of the given parameters, in the same order.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMandatoryValue(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">getMandatoryValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or throws an exception if none.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMemberName(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">getMemberName</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the parameter name as an instance of <code>MemberName</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOrCreate(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">getOrCreate</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValue(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">getValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or <code>null</code> if none.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getValueDomain(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">getValueDomain</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?> descriptor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the domain of valid values defined by the given descriptor, or <code>null</code> if none.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intValue(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">intValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the integer value of the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intValueList(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">intValueList</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><int[]> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the integer values of the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isUnmodifiable(org.opengis.parameter.ParameterValueGroup)" class="member-name-link">isUnmodifiable</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if the given parameter group is a non-null instance created by <code>unmodifiable(…)</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#print()" class="member-name-link">print</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints a string representation of this group to the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/System.html#out" title="class or interface in java.lang" class="external-link">standard output stream</a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stringValue(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">stringValue</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the string value of the parameter identified by the given descriptor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a string representation of this group.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unmodifiable(org.opengis.parameter.ParameterValueGroup)" class="member-name-link">unmodifiable</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the given parameter value group as an unmodifiable <code>Parameters</code> instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unmodifiable(org.opengis.parameter.ParameterValueGroup,java.util.function.Predicate)" class="member-name-link">unmodifiable</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><? super <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a>> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the given parameter value group as an unmodifiable <code>Parameters</code> instance |
| with some parameters hidden.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-ParameterValueGroup">Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#addGroup(java.lang.String)" title="class or interface in org.opengis.parameter" class="external-link">addGroup</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#getDescriptor()" title="class or interface in org.opengis.parameter" class="external-link">getDescriptor</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#groups(java.lang.String)" title="class or interface in org.opengis.parameter" class="external-link">groups</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#parameter(java.lang.String)" title="class or interface in org.opengis.parameter" class="external-link">parameter</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#values()" title="class or interface in org.opengis.parameter" class="external-link">values</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>Parameters</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Parameters</span>()</div> |
| <div class="block">For subclass constructors only.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isUnmodifiable(org.opengis.parameter.ParameterValueGroup)"> |
| <h3>isUnmodifiable</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isUnmodifiable</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</span></div> |
| <div class="block">Returns <code>true</code> if the given parameter group is a non-null instance created by <code>unmodifiable(…)</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - the parameter group to test. Can be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>whether the given parameters are non-null and unmodifiable.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unmodifiable(org.opengis.parameter.ParameterValueGroup)"> |
| <h3>unmodifiable</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></span> <span class="element-name">unmodifiable</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</span></div> |
| <div class="block">Returns the given parameter value group as an unmodifiable <code>Parameters</code> instance. |
| If the given parameters is already an unmodifiable instance of <code>Parameters</code>, |
| then it is returned as-is. Otherwise this method copies all parameter values in a new, |
| unmodifiable, parameter group instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - the parameters to make unmodifiable, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>an unmodifiable group with the same parameters than the given group, |
| or <code>null</code> if the given argument was null.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#unmodifiable(org.opengis.parameter.ParameterValue)"><code>DefaultParameterValue.unmodifiable(ParameterValue)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unmodifiable(org.opengis.parameter.ParameterValueGroup,java.util.function.Predicate)"> |
| <h3>unmodifiable</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></span> <span class="element-name">unmodifiable</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><? super <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a>> filter)</span></div> |
| <div class="block">Returns the given parameter value group as an unmodifiable <code>Parameters</code> instance |
| with some parameters hidden. The hidden parameters are excluded from the list returned |
| by <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#values()" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValueGroup.values()</code></a>, but are otherwise still accessible when the hidden |
| parameters is explicitly named in a call to <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#parameter(java.lang.String)" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValueGroup.parameter(String)</code></a>. |
| |
| <div class="note"><b>Use case:</b> |
| this method is used for hiding parameters that should be inferred from the context. |
| For example, the <code>"semi_major"</code> and <code>"semi_minor"</code> parameters are included |
| in the list of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>MathTransform</code></a> parameters |
| because that class has no way to know the values if they are not explicitly provided. |
| But those semi-axis length parameters should not be included in the list of |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>CoordinateOperation</code></a> parameters |
| because they are inferred from the context (the source and target CRS).</div></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - the parameters to make unmodifiable, or <code>null</code>.</dd> |
| <dd><code>filter</code> - specifies which source parameters to keep visible, or <code>null</code> if no filtering.</dd> |
| <dt>Returns:</dt> |
| <dd>an unmodifiable group with the parameters of the given group to keep visible, |
| or <code>null</code> if the <code>parameters</code> argument was null.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="castOrWrap(org.opengis.parameter.ParameterValueGroup)"> |
| <h3>castOrWrap</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></span> <span class="element-name">castOrWrap</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</span></div> |
| <div class="block">Returns the given parameter value group as a <code>Parameters</code> instance. |
| If the given parameters is already an instance of <code>Parameters</code>, then it is returned as-is. |
| Otherwise this method returns a wrapper which delegate all method invocations to the given instance. |
| |
| <p>This method provides a way to get access to the non-static <code>Parameters</code> methods, like |
| <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a>, for an arbitrary <code>ParameterValueGroup</code> instance.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - the object to cast or wrap, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the given argument as an instance of <code>Parameters</code> (may be the same reference), |
| or <code>null</code> if the given argument was null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cast(org.opengis.parameter.ParameterDescriptor,java.lang.Class)"> |
| <h3>cast</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T></span> <span class="element-name">cast</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?> descriptor, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> valueClass)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></span></div> |
| <div class="block">Casts the given parameter descriptor to the given type. |
| An exception is thrown immediately if the parameter does not have the expected |
| <a href="DefaultParameterDescriptor.html#getValueClass()">value class</a>.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the expected value class.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>descriptor</code> - the descriptor to cast, or <code>null</code>.</dd> |
| <dd><code>valueClass</code> - the expected value class.</dd> |
| <dt>Returns:</dt> |
| <dd>the descriptor casted to the given value class, or <code>null</code> if the given descriptor was null.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if the given descriptor does not have the expected value class.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html#cast(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>Class.cast(Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cast(org.opengis.parameter.ParameterValue,java.lang.Class)"> |
| <h3>cast</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><T></span> <span class="element-name">cast</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><?> parameter, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> valueClass)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></span></div> |
| <div class="block">Casts the given parameter value to the given type. |
| An exception is thrown immediately if the parameter does not have the expected value class.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the expected value class.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the parameter to cast, or <code>null</code>.</dd> |
| <dd><code>valueClass</code> - the expected value class.</dd> |
| <dt>Returns:</dt> |
| <dd>the value casted to the given type, or <code>null</code> if the given value was null.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if the given value doesn't have the expected value class.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html#cast(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>Class.cast(Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescriptors(org.opengis.parameter.GeneralParameterValue...)"> |
| <h3>getDescriptors</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a>[]</span> <span class="element-name">getDescriptors</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterValue</a>... parameters)</span></div> |
| <div class="block">Returns the descriptors of the given parameters, in the same order. |
| Special cases: |
| |
| <ul> |
| <li>If the given array is <code>null</code>, then this method returns <code>null</code>. |
| <li>If an element of the given array is <code>null</code>, then the corresponding |
| element of the returned array is also <code>null</code>.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - the parameter values from which to get the descriptors, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the descriptors of the given parameter values, or <code>null</code> if the <code>parameters</code> argument was null.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemberName(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>getMemberName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/MemberName.html" title="class or interface in org.opengis.util" class="external-link">MemberName</a></span> <span class="element-name">getMemberName</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?> parameter)</span></div> |
| <div class="block">Gets the parameter name as an instance of <code>MemberName</code>. |
| This method performs the following checks: |
| |
| <ul> |
| <li>If the <a href="../referencing/AbstractIdentifiedObject.html#getName()">primary name</a> is an instance of <code>MemberName</code> |
| (for example a <a href="../referencing/NamedIdentifier.html" title="class in org.apache.sis.referencing"><code>NamedIdentifier</code></a> subclass), returns that primary name.</li> |
| <li>Otherwise this method searches for the first <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">alias</a> |
| which is an instance of <code>MemberName</code> (a subtype of aliases type). |
| If found, that alias is returned.</li> |
| <li>If no alias is found, then this method tries to build a <code>MemberName</code> from the primary name and the |
| <a href="DefaultParameterDescriptor.html#getValueClass()">value class</a>, using the mapping defined in |
| <a href="../util/iso/DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a> javadoc.</li> |
| </ul> |
| |
| This method can be used as a bridge between the parameter object |
| defined by ISO 19111 (namely <code>CC_OperationParameter</code>) and the one |
| defined by ISO 19115 (namely <code>SV_Parameter</code>).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the parameter from which to get the name (may be <code>null</code>).</dd> |
| <dt>Returns:</dt> |
| <dd>the member name, or <code>null</code> if none.</dd> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../util/iso/Names.html#createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,java.lang.Class)"><code>Names.createMemberName(CharSequence, String, CharSequence, Class)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueDomain(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>getValueDomain</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?></span> <span class="element-name">getValueDomain</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?> descriptor)</span></div> |
| <div class="block">Returns the domain of valid values defined by the given descriptor, or <code>null</code> if none. |
| This method performs the following operations: |
| |
| <ul> |
| <li>If the given parameter is an instance of <code>DefaultParameterDescriptor</code>, |
| delegate to <a href="DefaultParameterDescriptor.html#getValueDomain()"><code>DefaultParameterDescriptor.getValueDomain()</code></a>.</li> |
| <li>Otherwise builds the range from the <a href="DefaultParameterDescriptor.html#getMinimumValue()">minimum value</a>, |
| <a href="DefaultParameterDescriptor.html#getMaximumValue()">maximum value</a> and, if the values are numeric, from |
| the <a href="DefaultParameterDescriptor.html#getUnit()">unit</a>.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>descriptor</code> - the parameter descriptor, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the domain of valid values, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterDescriptor.html#getValueDomain()"><code>DefaultParameterDescriptor.getValueDomain()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValue(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>getValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or <code>null</code> if none. |
| This method uses the following information from the given <code>parameter</code> descriptor: |
| |
| <ul> |
| <li>The most appropriate <a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> or |
| <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">alias</a> to use for searching |
| in this <code>ParameterValueGroup</code>, chosen as below: |
| <ul> |
| <li>a name or alias defined by the same |
| <a href="../referencing/ImmutableIdentifier.html#getAuthority()">authority</a>, if any;</li> |
| <li>an arbitrary name or alias otherwise.</li> |
| </ul> |
| </li> |
| <li>The <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> |
| to return if there is no value associated to the above-cited name or alias.</li> |
| <li>The <a href="DefaultParameterDescriptor.html#getUnit()">unit of measurement</a> |
| (if any) of numerical value to return.</li> |
| <li>The <a href="DefaultParameterDescriptor.html#getValueClass()">type</a> of value to return.</li> |
| </ul> |
| |
| This method can be useful when the <code>ParameterDescriptor</code> are known in advance, for example in the |
| implementation of some <a href="../referencing/operation/DefaultOperationMethod.html" title="class in org.apache.sis.referencing.operation">coordinate |
| operation method</a>. If the caller has no such <code>ParameterDescriptor</code> at hand, then the |
| <a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>parameter(String)</code></a> method is probably more convenient.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of the parameter value.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for, together with the desired type and unit of value.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise (which may be <code>null</code>).</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="../util/UnconvertibleObjectException.html" title="class in org.apache.sis.util">UnconvertibleObjectException</a></code> - if the parameter value cannot be converted to the expected type.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#getMandatoryValue(org.opengis.parameter.ParameterDescriptor)"><code>getMandatoryValue(ParameterDescriptor)</code></a></li> |
| <li><a href="#getOrCreate(org.opengis.parameter.ParameterDescriptor)"><code>getOrCreate(ParameterDescriptor)</code></a></li> |
| <li><a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>DefaultParameterValueGroup.parameter(String)</code></a></li> |
| <li><a href="DefaultParameterValue.html#getValue()"><code>DefaultParameterValue.getValue()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMandatoryValue(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>getMandatoryValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getMandatoryValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or throws an exception if none. |
| The default implementation performs the same work than <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> and verifies |
| that the returned value is non-null.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of the parameter value.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for, together with the desired type and unit of value.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise provided that it is not <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a></li> |
| <li><a href="#getOrCreate(org.opengis.parameter.ParameterDescriptor)"><code>getOrCreate(ParameterDescriptor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="booleanValue(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>booleanValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">booleanValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the boolean value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#booleanValue()"><code>DefaultParameterValue.booleanValue()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="intValue(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>intValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">intValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the integer value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#intValue()"><code>DefaultParameterValue.intValue()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="intValueList(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>intValueList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int[]</span> <span class="element-name">intValueList</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><int[]> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the integer values of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter values if they exist, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#intValueList()"><code>DefaultParameterValue.intValueList()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doubleValue(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>doubleValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">doubleValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the floating point value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this method |
| uses the given <code>parameter</code> argument. |
| |
| <p>If the given descriptor supplies a <a href="DefaultParameterDescriptor.html#getUnit()">unit of measurement</a>, then the returned value will be converted into that unit.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#doubleValue(javax.measure.Unit)"><code>DefaultParameterValue.doubleValue(Unit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doubleValue(org.opengis.parameter.ParameterDescriptor,javax.measure.Unit)"> |
| <h3>doubleValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">doubleValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>> parameter, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a><?> unit)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the floating point value of the parameter identified by the given descriptor, |
| converted to the given unit of measurement. See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> |
| for more information about how this method uses the given <code>parameter</code> argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dd><code>unit</code> - the desired unit of measurement.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the specified unit is invalid for the parameter.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#doubleValue(javax.measure.Unit)"><code>DefaultParameterValue.doubleValue(Unit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doubleValueList(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>doubleValueList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double[]</span> <span class="element-name">doubleValueList</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><double[]> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the floating point values of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this method |
| uses the given <code>parameter</code> argument. |
| |
| <p>If the given descriptor supplies a <a href="DefaultParameterDescriptor.html#getUnit()">unit of measurement</a>, then the returned values will be converted into that unit.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter values if they exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#doubleValueList(javax.measure.Unit)"><code>DefaultParameterValue.doubleValueList(Unit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stringValue(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>stringValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">stringValue</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the string value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html#stringValue()"><code>DefaultParameterValue.stringValue()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOrCreate(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>getOrCreate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><T></span> <span class="element-name">getOrCreate</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> parameter)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></span></div> |
| <div class="block">Returns the parameter identified by the given descriptor. |
| If the identified parameter is optional and not yet created, then it will be created now. |
| |
| <p>The default implementation is equivalent to:</p> |
| |
| <blockquote><pre><font color="green">return</font> <b>cast</b>(<b>parameter</b>(name), parameter.<b>getValueClass</b>());</pre></blockquote> |
| |
| where <code>name</code> is a <code>parameter</code> <a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> |
| or <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">alias</a> chosen by the same algorithm than |
| <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of the parameter value.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>parameter</code> - the parameter to look for.</dd> |
| <dt>Returns:</dt> |
| <dd>the requested parameter instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a></li> |
| <li><a href="#getMandatoryValue(org.opengis.parameter.ParameterDescriptor)"><code>getMandatoryValue(ParameterDescriptor)</code></a></li> |
| <li><a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>DefaultParameterValueGroup.parameter(String)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></span> <span class="element-name">clone</span>()</div> |
| <div class="block">Returns a copy of this group of parameter values. |
| The default implementation performs a <em>shallow</em> copy, |
| but subclasses are encouraged to perform a <em>deep</em> copy.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterValue.html#clone()" title="class or interface in org.opengis.parameter" class="external-link">clone</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterValue</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html#clone()" title="class or interface in org.opengis.parameter" class="external-link">clone</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a copy of this group of parameter values.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)"><code>copy(ParameterValueGroup, ParameterValueGroup)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> values, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> destination)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/InvalidParameterNameException.html" title="class or interface in org.opengis.parameter" class="external-link">InvalidParameterNameException</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/InvalidParameterValueException.html" title="class or interface in org.opengis.parameter" class="external-link">InvalidParameterValueException</a></span></div> |
| <div class="block">Copies the values of a parameter group into another parameter group. |
| All values in the <code>source</code> group shall be valid for the <code>destination</code> group, |
| but the <code>destination</code> may have more parameters. |
| Sub-groups are copied recursively. |
| |
| <p>A typical usage of this method is for transferring values from an arbitrary implementation |
| to some specific implementation, or to a parameter group using a different but compatible |
| <a href="DefaultParameterValueGroup.html#getDescriptor()">descriptor</a>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>values</code> - the parameter values to copy.</dd> |
| <dd><code>destination</code> - where to copy the values.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/InvalidParameterNameException.html" title="class or interface in org.opengis.parameter" class="external-link">InvalidParameterNameException</a></code> - if a <code>source</code> parameter name is unknown to the <code>destination</code>.</dd> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/InvalidParameterValueException.html" title="class or interface in org.opengis.parameter" class="external-link">InvalidParameterValueException</a></code> - if the value of a <code>source</code> parameter is invalid for the <code>destination</code>.</dd> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#clone()"><code>clone()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Returns a string representation of this group. |
| The default implementation delegates to <a href="ParameterFormat.html" title="class in org.apache.sis.parameter"><code>ParameterFormat</code></a>. |
| |
| <p>This method is for information purpose only and may change in future SIS version.</p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="print()"> |
| <h3>print</h3> |
| <div class="member-signature"><span class="annotations"><a href="../util/Debug.html" title="annotation interface in org.apache.sis.util">@Debug</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">print</span>()</div> |
| <div class="block">Prints a string representation of this group to the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/System.html#out" title="class or interface in java.lang" class="external-link">standard output stream</a>. |
| If a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Console.html" title="class or interface in java.io" class="external-link">console</a> is attached to the running JVM (i.e. if the application |
| is run from the command-line and the output is not redirected to a file) and if Apache SIS thinks |
| that the console supports the ANSI escape codes (a.k.a. X3.64), then a syntax coloring will be applied. |
| |
| <p>This is a convenience method for debugging purpose and for console applications.</p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
