| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultParameterValue (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.parameter.DefaultParameterValue class"> |
| <meta name="keywords" content="value"> |
| <meta name="keywords" content="unit"> |
| <meta name="keywords" content="getDescriptor()"> |
| <meta name="keywords" content="getUnit()"> |
| <meta name="keywords" content="getValue()"> |
| <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="valueFile()"> |
| <meta name="keywords" content="setValue()"> |
| <meta name="keywords" content="validate()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="unmodifiable()"> |
| <meta name="keywords" content="formatTo()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultParameterValue (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":9,"i24":10,"i25":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DefaultParameterValue.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.parameter</a></div> |
| <h2 title="Class DefaultParameterValue" class="title">Class DefaultParameterValue<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>DefaultParameterValue<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the value stored in this parameter.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><T></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DefaultParameterValue<T></span> |
| extends <a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><T>, <a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre> |
| <div class="block">A single parameter value used by an operation method. <code>ParameterValue</code> instances are elements in |
| a <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">parameter value group</a>, in a way similar to <code>Map.Entry</code> |
| instances in a <code>java.util.Map</code>. |
| |
| <p>In the context of coordinate operations, most parameter values are numeric and can be obtained by the |
| <a href="#intValue()"><code>intValue()</code></a> or <a href="#doubleValue()"><code>doubleValue()</code></a> methods. But other types of parameter values are possible |
| and can be handled by the more generic <a href="#getValue()"><code>getValue()</code></a> and <a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a> methods. |
| All <code>xxxValue()</code> methods in this class are convenience methods converting the value from <code>Object</code> |
| to some commonly used types. Those types are specified in ISO 19111 as an union of attributes, listed below with |
| the corresponding getter and setter methods:</p> |
| |
| <table class="sis"> |
| <caption>Mapping from ISO attributes to getters and setters</caption> |
| <tr><th>ISO attribute</th> <th>Java type</th> <th>Getter method</th> <th>Setter method</th></tr> |
| <tr><td></td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Object</code></a></td> <td><a href="#getValue()"><code>getValue()</code></a></td> <td><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></td></tr> |
| <tr><td>stringValue</td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td> <td><a href="#stringValue()"><code>stringValue()</code></a></td> <td><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></td></tr> |
| <tr><td>value</td> <td><code>double</code></td> <td><a href="#doubleValue()"><code>doubleValue()</code></a></td> <td><a href="#setValue(double)"><code>setValue(double)</code></a></td></tr> |
| <tr><td></td> <td><code>double</code></td> <td><a href="#doubleValue(javax.measure.Unit)"><code>doubleValue(Unit)</code></a></td> <td><a href="#setValue(double,javax.measure.Unit)"><code>setValue(double, Unit)</code></a></td></tr> |
| <tr><td>valueList</td> <td><code>double[]</code></td> <td><a href="#doubleValueList()"><code>doubleValueList()</code></a></td> <td><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></td></tr> |
| <tr><td></td> <td><code>double[]</code></td> <td><a href="#doubleValueList(javax.measure.Unit)"><code>doubleValueList(Unit)</code></a></td> <td><a href="#setValue(double%5B%5D,javax.measure.Unit)"><code>setValue(double[], Unit)</code></a></td></tr> |
| <tr><td>integerValue</td> <td><code>int</code></td> <td><a href="#intValue()"><code>intValue()</code></a></td> <td><a href="#setValue(int)"><code>setValue(int)</code></a></td></tr> |
| <tr><td>integerValueList</td> <td><code>int[]</code></td> <td><a href="#intValueList()"><code>intValueList()</code></a></td> <td><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></td></tr> |
| <tr><td>booleanValue</td> <td><code>boolean</code></td> <td><a href="#booleanValue()"><code>booleanValue()</code></a></td> <td><a href="#setValue(boolean)"><code>setValue(boolean)</code></a></td></tr> |
| <tr><td>valueFile</td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a></td> <td><a href="#valueFile()"><code>valueFile()</code></a></td> <td><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></td></tr> |
| <tr><td>valueFileCitation</td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink"><code>Citation</code></a></td> <td><a href="#getValue()"><code>getValue()</code></a></td> <td><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></td></tr> |
| </table> |
| |
| The type and constraints on parameter values are given by the <a href="#getDescriptor()">descriptor</a>, |
| which is specified at construction time. The parameter type can be fetch with the following idiom: |
| |
| <blockquote><pre>Class<T> valueClass = parameter.<b>getDescriptor</b>().<b>getValueClass</b>();</pre></blockquote> |
| |
| <div class="section">Instantiation</div> |
| A <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">parameter descriptor</a> must be defined before parameter value can be created. |
| Descriptors are usually pre-defined by map projection or process providers. Given a descriptor, a parameter value can |
| be created by a call to the <a href="#%3Cinit%3E(org.opengis.parameter.ParameterDescriptor)"><code>DefaultParameterValue(ParameterDescriptor)</code></a> constructor or by a call to the |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#createValue()" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterDescriptor.createValue()</code></a> method. The later is recommended since it allows descriptors to return |
| specialized implementations. |
| |
| <div class="section">Implementation note for subclasses</div> |
| All read and write operations (except constructors, <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> and <a href="#hashCode()"><code>hashCode()</code></a>) |
| ultimately delegates to the following methods: |
| |
| <ul> |
| <li>All getter methods will invoke <a href="#getValue()"><code>getValue()</code></a> and <a href="#getUnit()"><code>getUnit()</code></a> (if needed), |
| then perform their processing on the values returned by those methods.</li> |
| <li>All setter methods delegate to the <a href="#setValue(java.lang.Object,javax.measure.Unit)"><code>setValue(Object, Unit)</code></a> method.</li> |
| </ul> |
| |
| Consequently, the above-cited methods provide single points that subclasses can override |
| for modifying the behavior of all getter and setter methods.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter"><code>DefaultParameterDescriptor</code></a>, |
| <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter"><code>DefaultParameterValueGroup</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.parameter.DefaultParameterValue">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unit">unit</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The unit of measure for the value, or <code>null</code> if it does not apply.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#value">value</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The value, or <code>null</code> if undefined.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.parameter.ParameterDescriptor)">DefaultParameterValue</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>> descriptor)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a parameter value from the specified descriptor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.parameter.ParameterValue)">DefaultParameterValue</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance initialized with the values from the specified parameter object.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#booleanValue()">booleanValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the boolean value of this parameter.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter">DefaultParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a clone of this parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doubleValue()">doubleValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the numeric value of this parameter.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doubleValue(javax.measure.Unit)">doubleValue</a></span>​(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the numeric value of this parameter in the given unit of measure.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doubleValueList()">doubleValueList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an ordered sequence of two or more numeric values of this parameter, |
| where each value has the same associated unit of measure.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doubleValueList(javax.measure.Unit)">doubleValueList</a></span>​(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an ordered sequence of numeric values in the specified unit of measure.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares the specified object with this parameter for equality.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object, |
| <a href="../util/ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a> mode)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares the specified object with this parameter for equality.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a></span>​(<a href="../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a> formatter)</code></th> |
| <td class="colLast"> |
| <div class="block">Formats this parameter as a <cite>Well Known Text</cite> <code>Parameter[…]</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptor()">getDescriptor</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the definition of this parameter.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnit()">getUnit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the unit of measure of the parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue()">getValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the parameter value as an object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a hash value for this parameter.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intValue()">intValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the integer value of this parameter, usually used for a count.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intValueList()">intValueList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an ordered sequence of two or more integer values of this parameter, usually used for counts.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(boolean)">setValue</a></span>​(boolean newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value as a boolean.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(double)">setValue</a></span>​(double newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value as a floating point.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(double%5B%5D,javax.measure.Unit)">setValue</a></span>​(double[] newValues, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value as an array of floating point and their associated unit.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(double,javax.measure.Unit)">setValue</a></span>​(double newValue, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value as a floating point and its associated unit.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(int)">setValue</a></span>​(int newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value as an integer.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(java.lang.Object)">setValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value as an object.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(java.lang.Object,javax.measure.Unit)">setValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> newValue, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the parameter value and its associated unit.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stringValue()">stringValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the string value of this parameter.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter">DefaultParameterValue</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmodifiable(org.opengis.parameter.ParameterValue)">unmodifiable</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><T> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an unmodifiable implementation of the given parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(T)">validate</a></span>​(<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Invoked by <a href="#setValue(java.lang.Object,javax.measure.Unit)"><code>setValue(Object, Unit)</code></a> after the basic verifications have been done and before |
| the value is stored.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueFile()">valueFile</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a reference to a file or a part of a file containing one or more parameter values.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.FormattableObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3> |
| <code><a href="../io/wkt/FormattableObject.html#print()">print</a>, <a href="../io/wkt/FormattableObject.html#toString()">toString</a>, <a href="../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="value"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>protected <a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a> value</pre> |
| <div class="block">The value, or <code>null</code> if undefined. |
| Except for the constructors, the <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> and the <a href="#hashCode()"><code>hashCode()</code></a> methods, |
| this field should be read only by <a href="#getValue()"><code>getValue()</code></a> and written only by <a href="#setValue(java.lang.Object,javax.measure.Unit)"><code>setValue(Object, Unit)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unit"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>unit</h4> |
| <pre>protected <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit</pre> |
| <div class="block">The unit of measure for the value, or <code>null</code> if it does not apply. |
| Except for the constructors, the <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> and the <a href="#hashCode()"><code>hashCode()</code></a> methods, |
| this field should be read only by <a href="#getUnit()"><code>getUnit()</code></a> and written only by <a href="#setValue(java.lang.Object,javax.measure.Unit)"><code>setValue(Object, Unit)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultParameterValue</h4> |
| <pre>public DefaultParameterValue​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>> descriptor)</pre> |
| <div class="block">Creates a parameter value from the specified descriptor. |
| The value will be initialized to the default value, if any.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - the abstract definition of this parameter.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.parameter.ParameterValue)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultParameterValue</h4> |
| <pre>public DefaultParameterValue​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>> parameter)</pre> |
| <div class="block">Creates a new instance initialized with the values from the specified parameter object. |
| This is a <em>shallow</em> copy constructor, since the value contained in the given |
| object is not cloned.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the parameter to copy values from.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#clone()"><code>clone()</code></a>, |
| <a href="#unmodifiable(org.opengis.parameter.ParameterValue)"><code>unmodifiable(ParameterValue)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getDescriptor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptor</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>> getDescriptor()</pre> |
| <div class="block">Returns the definition of this parameter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true#getDescriptor()" title="class or interface in org.opengis.parameter" class="externalLink">getDescriptor</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#getDescriptor()" title="class or interface in org.opengis.parameter" class="externalLink">getDescriptor</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the definition of this parameter.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUnit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnit</h4> |
| <pre class="methodSignature">public <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> getUnit()</pre> |
| <div class="block">Returns the unit of measure of the parameter value. |
| If the parameter value has no unit (for example because it is a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> type), |
| then this method returns <code>null</code>. Note that "no unit" does not mean "dimensionless". |
| |
| <div class="section">Implementation note for subclasses</div> |
| All getter methods which need unit information will invoke this <code>getUnit()</code> method. |
| Subclasses can override this method if they need to compute the unit dynamically.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#getUnit()" title="class or interface in org.opengis.parameter" class="externalLink">getUnit</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unit of measure, or <code>null</code> if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#doubleValue()"><code>doubleValue()</code></a>, |
| <a href="#doubleValueList()"><code>doubleValueList()</code></a>, |
| <a href="#getValue()"><code>getValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre class="methodSignature">public <a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a> getValue()</pre> |
| <div class="block">Returns the parameter value as an object. |
| If no value has been set, then this method returns the |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> (which may be null). |
| |
| <div class="section">Implementation note for subclasses</div> |
| All getter methods will invoke this <code>getValue()</code> method. |
| Subclasses can override this method if they need to compute the value dynamically.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#getValue()" title="class or interface in org.opengis.parameter" class="externalLink">getValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter value as an object, or <code>null</code> if no value has been set |
| and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a>, |
| <a href="Parameters.html#getValue(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.getValue(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="booleanValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>booleanValue</h4> |
| <pre class="methodSignature">public boolean booleanValue() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns the boolean value of this parameter. |
| A boolean value does not have an associated unit of measure. |
| |
| <p>The default implementation invokes <a href="#getValue()"><code>getValue()</code></a> and casts the result if possible, |
| or throws an exception otherwise.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#booleanValue()" title="class or interface in org.opengis.parameter" class="externalLink">booleanValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the boolean value represented by this parameter.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not a boolean type.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setValue(boolean)"><code>setValue(boolean)</code></a>, |
| <a href="Parameters.html#booleanValue(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.booleanValue(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="intValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intValue</h4> |
| <pre class="methodSignature">public int intValue() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns the integer value of this parameter, usually used for a count. |
| An integer value does not have an associated unit of measure. |
| |
| <p>The default implementation invokes <a href="#getValue()"><code>getValue()</code></a> and casts the result if possible, |
| or throws an exception otherwise.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#intValue()" title="class or interface in org.opengis.parameter" class="externalLink">intValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the numeric value represented by this parameter after conversion to type <code>int</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not an integer type.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setValue(int)"><code>setValue(int)</code></a>, |
| <a href="#intValueList()"><code>intValueList()</code></a>, |
| <a href="Parameters.html#intValue(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.intValue(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="intValueList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intValueList</h4> |
| <pre class="methodSignature">public int[] intValueList() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns an ordered sequence of two or more integer values of this parameter, usually used for counts. |
| |
| <p>The default implementation invokes <a href="#getValue()"><code>getValue()</code></a> and casts the result if possible, |
| or throws an exception otherwise. If the value can be casted, then the array is cloned before |
| to be returned.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#intValueList()" title="class or interface in org.opengis.parameter" class="externalLink">intValueList</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of the sequence of values represented by this parameter.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not an array of <code>int</code>s.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a>, |
| <a href="#intValue()"><code>intValue()</code></a>, |
| <a href="Parameters.html#intValueList(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.intValueList(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doubleValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValue</h4> |
| <pre class="methodSignature">public double doubleValue() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns the numeric value of this parameter. |
| The units of measurement are specified by <a href="#getUnit()"><code>getUnit()</code></a>. |
| |
| <p>The default implementation invokes <a href="#getValue()"><code>getValue()</code></a> and casts the result if possible, |
| or throws an exception otherwise.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#doubleValue()" title="class or interface in org.opengis.parameter" class="externalLink">doubleValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the numeric value represented by this parameter after conversion to type <code>double</code>. |
| This method returns <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink"><code>Double.NaN</code></a> only if such "value" has been explicitly set.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not a numeric type.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getUnit()"><code>getUnit()</code></a>, |
| <a href="#setValue(double)"><code>setValue(double)</code></a>, |
| <a href="#doubleValueList()"><code>doubleValueList()</code></a>, |
| <a href="Parameters.html#doubleValue(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.doubleValue(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doubleValueList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValueList</h4> |
| <pre class="methodSignature">public double[] doubleValueList() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns an ordered sequence of two or more numeric values of this parameter, |
| where each value has the same associated unit of measure. |
| |
| <p>The default implementation invokes <a href="#getValue()"><code>getValue()</code></a> and casts the result if possible, |
| or throws an exception otherwise. If the value can be casted, then the array is cloned before |
| to be returned.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#doubleValueList()" title="class or interface in org.opengis.parameter" class="externalLink">doubleValueList</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of the sequence of values represented by this parameter.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not an array of <code>double</code>s.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getUnit()"><code>getUnit()</code></a>, |
| <a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a>, |
| <a href="#doubleValue()"><code>doubleValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doubleValue(javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValue</h4> |
| <pre class="methodSignature">public double doubleValue​(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns the numeric value of this parameter in the given unit of measure. |
| This convenience method applies unit conversions on the fly as needed. |
| |
| <p>The default implementation invokes <a href="#doubleValue()"><code>doubleValue()</code></a> and <a href="#getUnit()"><code>getUnit()</code></a>, |
| then converts the values to the given unit of measurement.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#doubleValue(javax.measure.Unit)" title="class or interface in org.opengis.parameter" class="externalLink">doubleValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>unit</code> - the unit of measure for the value to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the numeric value represented by this parameter after conversion to type |
| <code>double</code> and conversion to <code>unit</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the specified unit is invalid for this parameter.</dd> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not a numeric type.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getUnit()"><code>getUnit()</code></a>, |
| <a href="#setValue(double,javax.measure.Unit)"><code>setValue(double,Unit)</code></a>, |
| <a href="#doubleValueList(javax.measure.Unit)"><code>doubleValueList(Unit)</code></a>, |
| <a href="Parameters.html#doubleValue(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.doubleValue(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doubleValueList(javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValueList</h4> |
| <pre class="methodSignature">public double[] doubleValueList​(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns an ordered sequence of numeric values in the specified unit of measure. |
| This convenience method applies unit conversions on the fly as needed. |
| |
| <p>The default implementation invokes <a href="#doubleValueList()"><code>doubleValueList()</code></a> and <a href="#getUnit()"><code>getUnit()</code></a>, |
| then converts the values to the given unit of measurement.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#doubleValueList(javax.measure.Unit)" title="class or interface in org.opengis.parameter" class="externalLink">doubleValueList</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>unit</code> - the unit of measure for the value to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sequence of values represented by this parameter after conversion to type |
| <code>double</code> and conversion to <code>unit</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the specified unit is invalid for this parameter.</dd> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not an array of <code>double</code>s.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getUnit()"><code>getUnit()</code></a>, |
| <a href="#setValue(double%5B%5D,javax.measure.Unit)"><code>setValue(double[],Unit)</code></a>, |
| <a href="#doubleValue(javax.measure.Unit)"><code>doubleValue(Unit)</code></a>, |
| <a href="Parameters.html#doubleValueList(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.doubleValueList(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stringValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stringValue</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> stringValue() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns the string value of this parameter. |
| A string value does not have an associated unit of measure.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#stringValue()" title="class or interface in org.opengis.parameter" class="externalLink">stringValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string value represented by this parameter.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not a string.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getValue()"><code>getValue()</code></a>, |
| <a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a>, |
| <a href="Parameters.html#stringValue(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.stringValue(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="valueFile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueFile</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> valueFile() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns a reference to a file or a part of a file containing one or more parameter values. |
| The default implementation can convert the following value types: |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URL</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file" class="externalLink"><code>Path</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>File</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#valueFile()" title="class or interface in org.opengis.parameter" class="externalLink">valueFile</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the reference to a file containing parameter values.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterTypeException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterTypeException</a></code> - if the value is not a reference to a file or a URI.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getValue()"><code>getValue()</code></a>, |
| <a href="#setValue(java.lang.Object)"><code>setValue(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public void setValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> newValue) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value as an object. The object type is typically (but not limited to) <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a>, |
| <code>double[]</code>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Integer</code></a>, <code>int[]</code>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Boolean</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a>. |
| If the given value is <code>null</code>, then this parameter is set to the |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a>. |
| If the given value is not an instance of the expected type, then this method may perform automatically |
| a type conversion (for example from <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Float</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a> or from <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file" class="externalLink"><code>Path</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a>) |
| if such conversion can be done without information lost.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#setValue(java.lang.Object)" title="class or interface in org.opengis.parameter" class="externalLink">setValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the parameter value, or <code>null</code> to restore the default.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the type of <code>value</code> is inappropriate for this parameter, |
| or if the value is illegal for some other reason (for example the value is numeric and out of range).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getValue()"><code>getValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public void setValue​(boolean newValue) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value as a boolean.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#setValue(boolean)" title="class or interface in org.opengis.parameter" class="externalLink">setValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the parameter value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the boolean type is inappropriate for this parameter.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#booleanValue()"><code>booleanValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public void setValue​(int newValue) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value as an integer. This method automatically wraps the given integer |
| in an object of the type specified by the <a href="#getDescriptor()">descriptor</a> if that |
| conversion can be done without information lost.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#setValue(int)" title="class or interface in org.opengis.parameter" class="externalLink">setValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the parameter value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the integer type is inappropriate for this parameter, |
| or if the value is illegal for some other reason (for example a value out of range).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#intValue()"><code>intValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public void setValue​(double newValue) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value as a floating point. The unit, if any, stay unchanged. This method automatically |
| wraps the given number in an object of the type specified by the <a href="#getDescriptor()">descriptor</a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#setValue(double)" title="class or interface in org.opengis.parameter" class="externalLink">setValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the parameter value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the floating point type is inappropriate for this parameter, |
| or if the value is illegal for some other reason (for example a value out of range).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setValue(double,javax.measure.Unit)"><code>setValue(double,Unit)</code></a>, |
| <a href="#doubleValue()"><code>doubleValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(double,javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public void setValue​(double newValue, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value as a floating point and its associated unit. This method automatically wraps |
| the given number in an object of the type specified by the <a href="#getDescriptor()">descriptor</a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#setValue(double,javax.measure.Unit)" title="class or interface in org.opengis.parameter" class="externalLink">setValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the parameter value.</dd> |
| <dd><code>unit</code> - the unit for the specified value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the floating point type is inappropriate for this parameter, |
| or if the value is illegal for some other reason (for example a value out of range).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setValue(double)"><code>setValue(double)</code></a>, |
| <a href="#doubleValue(javax.measure.Unit)"><code>doubleValue(Unit)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(double[],javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public void setValue​(double[] newValues, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value as an array of floating point and their associated unit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#setValue(double%5B%5D,javax.measure.Unit)" title="class or interface in org.opengis.parameter" class="externalLink">setValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValues</code> - the parameter values.</dd> |
| <dd><code>unit</code> - the unit for the specified value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the floating point array type is inappropriate for this parameter, |
| or if the value is illegal for some other reason (for example a value out of range).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(java.lang.Object,javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">protected void setValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> newValue, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Sets the parameter value and its associated unit. |
| If the given value is <code>null</code>, then this parameter is set to the |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a>. |
| Otherwise the given value shall be an instance of the class expected by the <a href="#getDescriptor()">descriptor</a>. |
| |
| <ul> |
| <li>This method does not perform any type conversion. Type conversion, if desired, should be |
| applied by the public <code>setValue(…)</code> methods before to invoke this protected method.</li> |
| <li>This method does not clone the given value. In particular, references to <code>int[]</code> and |
| <code>double[]</code> arrays are stored <cite>as-is</cite>.</li> |
| </ul> |
| |
| <div class="section">Implementation note for subclasses</div> |
| This method is invoked by all setter methods in this class, thus providing a single point that |
| subclasses can override if they want to perform more processing on the value before its storage, |
| or to be notified about value changes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the parameter value, or <code>null</code> to restore the default.</dd> |
| <dd><code>unit</code> - the unit associated to the new parameter value, or <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the type of <code>value</code> is inappropriate for this parameter, |
| or if the value is illegal for some other reason (for example the value is numeric and out of range).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#validate(T)"><code>validate(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="validate(java.lang.Object)"> |
| <!-- --> |
| </a><a id="validate(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre class="methodSignature">protected void validate​(<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a> newValue) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Invoked by <a href="#setValue(java.lang.Object,javax.measure.Unit)"><code>setValue(Object, Unit)</code></a> after the basic verifications have been done and before |
| the value is stored. Subclasses can override this method for performing additional verifications. |
| |
| <div class="section">Unit of measurement</div> |
| If the user specified a unit of measurement, then the value given to this method has been converted |
| to the unit specified by the <a href="#getDescriptor()">descriptor</a>, for easier comparisons against |
| standardized values. This converted value may be different than the value to be stored in this |
| <code>ParameterValue</code>, since the later value will be stored in the unit specified by the user. |
| |
| <div class="section">Standard validations</div> |
| The checks for <a href="DefaultParameterDescriptor.html#getValueClass()">value class</a>, |
| for <a href="DefaultParameterDescriptor.html#getValueDomain()">value domain</a> and for |
| <a href="DefaultParameterDescriptor.html#getValidValues()">valid values</a> are performed |
| before this method is invoked. The default implementation of this method does nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the value converted to the unit of measurement specified by the descriptor.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the given value is invalid for implementation-specific reasons.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object, |
| <a href="../util/ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a> mode)</pre> |
| <div class="block">Compares the specified object with this parameter for equality. |
| The strictness level is controlled by the second argument.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../util/LenientComparable.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code> in interface <code><a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to compare to <code>this</code>.</dd> |
| <dd><code>mode</code> - the strictness level of the comparison.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if both objects are equal according the given comparison mode.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../util/Utilities.html#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>Utilities.deepEquals(Object, Object, ComparisonMode)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public final boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</pre> |
| <div class="block">Compares the specified object with this parameter for equality. |
| This method is implemented as below: |
| |
| <blockquote><pre><font color="green">return</font> <b>equals</b>(other, ComparisonMode.STRICT);</pre></blockquote> |
| |
| Subclasses shall override <a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>equals(Object, ComparisonMode)</code></a> instead than this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../util/LenientComparable.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to compare to <code>this</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if both objects are equal.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../util/ComparisonMode.html#STRICT"><code>ComparisonMode.STRICT</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <div class="block">Returns a hash value for this parameter. |
| This value does not need to be the same in past or future versions of this class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the hash code value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter">DefaultParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>> clone()</pre> |
| <div class="block">Returns a clone of this parameter value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true#clone()" title="class or interface in org.opengis.parameter" class="externalLink">clone</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true#clone()" title="class or interface in org.opengis.parameter" class="externalLink">clone</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterValue.html" title="type parameter in DefaultParameterValue">T</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#%3Cinit%3E(org.opengis.parameter.ParameterValue)"><code>DefaultParameterValue(ParameterValue)</code></a>, |
| <a href="#unmodifiable(org.opengis.parameter.ParameterValue)"><code>unmodifiable(ParameterValue)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmodifiable(org.opengis.parameter.ParameterValue)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmodifiable</h4> |
| <pre class="methodSignature">public static <T> <a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter">DefaultParameterValue</a><T> unmodifiable​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><T> parameter)</pre> |
| <div class="block">Returns an unmodifiable implementation of the given parameter value. |
| This method shall be used only with: |
| |
| <ul> |
| <li>immutable <a href="#getDescriptor()">descriptor</a>,</li> |
| <li>immutable or null <a href="#getUnit()">unit</a>, and</li> |
| <li>immutable or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">cloneable</a> parameter <a href="#getValue()">value</a>.</li> |
| </ul> |
| |
| If the parameter value implements the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Cloneable</code></a> interface and has a public <code>clone()</code> method, |
| then that value will be cloned every time the <a href="#getValue()"><code>getValue()</code></a> method is invoked. |
| The value is not cloned by this method however; it is caller's responsibility to not modify the value of |
| the given <code>parameter</code> instance after this method call. |
| |
| <div class="section">Instances sharing</div> |
| If this method is invoked more than once with equal <a href="#getDescriptor()">descriptor</a>, |
| <a href="#getValue()">value</a> and <a href="#getUnit()">unit</a>, then this method will return |
| the same <code>DefaultParameterValue</code> instance on a <cite>best effort</cite> basis. |
| |
| <div class="note"><b>Rational:</b> |
| the same parameter value is often used in many different coordinate operations. For example all <cite>Universal |
| Transverse Mercator</cite> (UTM) projections use the same scale factor (0.9996) and false easting (500000 metres). |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the value stored in the given parameter.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the parameter to make unmodifiable, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a unmodifiable implementation of the given parameter, or <code>null</code> if the given parameter was null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Parameters.html#unmodifiable(org.opengis.parameter.ParameterValueGroup)"><code>Parameters.unmodifiable(ParameterValueGroup)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="formatTo(org.apache.sis.io.wkt.Formatter)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>formatTo</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> formatTo​(<a href="../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a> formatter)</pre> |
| <div class="block">Formats this parameter as a <cite>Well Known Text</cite> <code>Parameter[…]</code> element. |
| Example: |
| |
| <blockquote><pre>Parameter["False easting", 0.0, LengthUnit["metre", 1]]</pre></blockquote> |
| |
| <div class="section">Unit of measurement</div> |
| The units of measurement were never specified in WKT 1 format, and are optional in WKT 2 format. |
| If the units are not specified, then they are inferred from the context. |
| Typically, parameter values that are lengths are given in the unit for the projected CRS axes |
| while parameter values that are angles are given in the unit for the base geographic CRS. |
| |
| <div class="note"><b>Example:</b> |
| The snippet below show WKT representations of the map projection parameters of a projected CRS |
| (most other elements are omitted). The map projection uses a <cite>"Latitude of natural origin"</cite> |
| parameters which is set to 52 <strong>grads</strong>, as defined in the <code>UNIT[…]</code> element of the |
| enclosing CRS. A similar rule applies to <cite>“False easting”</cite> and <cite>“False northing”</cite> |
| parameters, which are in kilometres in this example. |
| |
| <p><b>WKT 1:</b></p> |
| <blockquote><pre>PROJCS[…, |
| GEOGCS[…, |
| UNIT[“grad”, 0.015707963267948967]], // Unit for all angles |
| PROJECTION[“Lambert_Conformal_Conic_1SP”] |
| PARAMETER[“latitude_of_origin”, 52.0], // In grads |
| PARAMETER[“scale_factor”, 0.99987742], |
| PARAMETER[“false_easting”, 600.0], // In kilometres |
| PARAMETER[“false_northing”, 2200.0], // In kilometres |
| UNIT[“kilometre”, 1000]] // Unit for all lengths</pre></blockquote> |
| |
| <p><b>WKT 2:</b></p> |
| <blockquote><pre>ProjectedCRS[… |
| BaseGeodCRS[… |
| AngleUnit[“grad”, 0.015707963267948967]], |
| Conversion[“Lambert zone II”, |
| Method[“Lambert Conic Conformal (1SP)”], |
| Parameter[“Latitude of natural origin”, 52.0], |
| Parameter[“Scale factor at natural origin”, 0.99987742], |
| Parameter[“False easting”, 600.0], |
| Parameter[“False northing”, 2200.0]], |
| CS[“Cartesian”, 2], |
| LengthUnit[“kilometre”, 1000]]</pre></blockquote> |
| </div></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../io/wkt/FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a></code> in class <code><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>formatter</code> - the formatter where to format the inner content of this WKT element.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>"Parameter"</code> or <code>"ParameterFile"</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#119">WKT 2 specification §17.2.4</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DefaultParameterValue.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
