| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>ArgumentChecks (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.util, package: org.apache.sis.util, class: ArgumentChecks"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.ArgumentChecks class"> |
| <meta name="keywords" content="ensureNonNull()"> |
| <meta name="keywords" content="ensureNonNullElement()"> |
| <meta name="keywords" content="ensureNonEmpty()"> |
| <meta name="keywords" content="ensureNonEmptyBounded()"> |
| <meta name="keywords" content="ensureExpectedCount()"> |
| <meta name="keywords" content="ensureCanCast()"> |
| <meta name="keywords" content="ensureValidIndex()"> |
| <meta name="keywords" content="ensureValidIndexRange()"> |
| <meta name="keywords" content="ensurePositive()"> |
| <meta name="keywords" content="ensureStrictlyPositive()"> |
| <meta name="keywords" content="ensureFinite()"> |
| <meta name="keywords" content="ensureBetween()"> |
| <meta name="keywords" content="ensureSizeBetween()"> |
| <meta name="keywords" content="ensureCountBetween()"> |
| <meta name="keywords" content="ensureValidUnicodeCodePoint()"> |
| <meta name="keywords" content="ensureDivisor()"> |
| <meta name="keywords" content="ensureMultiple()"> |
| <meta name="keywords" content="ensureDimensionMatches()"> |
| <meta name="keywords" content="ensureDimensionsMatch()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.util</a></div> |
| <h1 title="Class ArgumentChecks" class="title">Class ArgumentChecks</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="Static.html" title="class in org.apache.sis.util">Static</a> |
| <div class="inheritance">ArgumentChecks</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ArgumentChecks</span> |
| <span class="extends-implements">extends <a href="Static.html" title="class in org.apache.sis.util">Static</a></span></div> |
| <div class="block">Static methods for performing argument checks. |
| Every methods in this class can throw one of the following exceptions: |
| |
| <table class="sis"> |
| <caption>Exceptions thrown on illegal argument</caption> |
| <tr> |
| <th>Exception</th> |
| <th class="sep">Thrown by</th> |
| </tr><tr> |
| <td><a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a></td> |
| <td class="sep"> |
| <a href="#ensureNonNull(java.lang.String,java.lang.Object)"><code>ensureNonNull</code></a>, |
| <a href="#ensureNonEmpty(java.lang.String,java.lang.CharSequence)"><code>ensureNonEmpty</code></a>. |
| </td> |
| </tr><tr> |
| <td><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a></td> |
| <td class="sep"> |
| <a href="#ensureNonEmpty(java.lang.String,java.lang.CharSequence)"><code>ensureNonEmpty</code></a>, |
| <a href="#ensurePositive(java.lang.String,int)"><code>ensurePositive</code></a>, |
| <a href="#ensureStrictlyPositive(java.lang.String,int)"><code>ensureStrictlyPositive</code></a>, |
| <a href="#ensureBetween(java.lang.String,int,int,int)"><code>ensureBetween</code></a>, |
| <a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween</code></a>, |
| <a href="#ensureNonEmptyBounded(java.lang.String,boolean,int,int,int%5B%5D)"><code>ensureNonEmptyBounded</code></a>, |
| <a href="#ensureCanCast(java.lang.String,java.lang.Class,java.lang.Object)"><code>ensureCanCast</code></a>. |
| </td> |
| </tr><tr> |
| <td><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link"><code>IndexOutOfBoundsException</code></a></td> |
| <td class="sep"> |
| <a href="#ensureValidIndex(int,int)"><code>ensureValidIndex</code></a>. |
| </td> |
| </tr><tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link"><code>MismatchedDimensionException</code></a></td> |
| <td class="sep"> |
| <a href="#ensureDimensionMatches(java.lang.String,int,org.opengis.geometry.DirectPosition)"><code>ensureDimensionMatches</code></a>. |
| </td> |
| </tr> |
| </table> |
| |
| More specialized <code>ensureXXX(…)</code> methods are provided in the following classes: |
| <ul> |
| <li><a href="../measure/Units.html" title="class in org.apache.sis.measure"><code>Units</code></a>: |
| <a href="../measure/Units.html#ensureAngular(javax.measure.Unit)"><code>ensureAngular</code></a>, |
| <a href="../measure/Units.html#ensureLinear(javax.measure.Unit)"><code>ensureLinear</code></a>, |
| <a href="../measure/Units.html#ensureTemporal(javax.measure.Unit)"><code>ensureTemporal</code></a>, |
| <a href="../measure/Units.html#ensureScale(javax.measure.Unit)"><code>ensureScale</code></a>.</li> |
| </ul> |
| |
| <h2 id="method-arguments-heading">Method Arguments</h2> |
| By convention, the value to check is always the last parameter given to every methods in this class. |
| The other parameters may include the programmatic name of the argument being checked. |
| This programmatic name is used for building an error message localized in the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html#getDefault()" title="class or interface in java.util" class="external-link">default locale</a> if the check failed.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureBetween(java.lang.String,double,double,double)" class="member-name-link">ensureBetween</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double min, |
| double max, |
| double value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is between the given bounds, inclusive.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureBetween(java.lang.String,float,float,float)" class="member-name-link">ensureBetween</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float min, |
| float max, |
| float value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is between the given bounds, inclusive.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureBetween(java.lang.String,int,int,int)" class="member-name-link">ensureBetween</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int min, |
| int max, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given integer value is between the given bounds, inclusive.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureBetween(java.lang.String,long,long,long)" class="member-name-link">ensureBetween</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long min, |
| long max, |
| long value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given long value is between the given bounds, inclusive.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureCanCast(java.lang.String,java.lang.Class,java.lang.Object)" class="member-name-link">ensureCanCast</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> expectedType, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the specified value is null or an instance assignable to the given type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)" class="member-name-link">ensureCountBetween</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean named, |
| int min, |
| int max, |
| int count)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given number of elements is between the given bounds, inclusive.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionMatches(java.lang.String,int,double%5B%5D)" class="member-name-link">ensureDimensionMatches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| double[] vector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given vector, if non-null, has the expected number of dimensions |
| (taken as its length).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionMatches(java.lang.String,int,int%5B%5D)" class="member-name-link">ensureDimensionMatches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| int[] indices)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given array of indices, if non-null, has the expected number of dimensions |
| (taken as its length).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionMatches(java.lang.String,int,org.opengis.geometry.DirectPosition)" class="member-name-link">ensureDimensionMatches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a> position)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given direct position, if non-null, has the expected number of dimensions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionMatches(java.lang.String,int,org.opengis.geometry.Envelope)" class="member-name-link">ensureDimensionMatches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a> envelope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given envelope, if non-null, has the expected number of dimensions.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionMatches(java.lang.String,int,org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">ensureDimensionMatches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given CRS, if non-null, has the expected number of dimensions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionMatches(java.lang.String,int,org.opengis.referencing.cs.CoordinateSystem)" class="member-name-link">ensureDimensionMatches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">CoordinateSystem</a> cs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given coordinate system, if non-null, has the expected number of dimensions.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDimensionsMatch(java.lang.String,int,int,org.opengis.referencing.operation.MathTransform)" class="member-name-link">ensureDimensionsMatch</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expectedSource, |
| int expectedTarget, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a> transform)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given transform, if non-null, has the expected number of source and target dimensions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureDivisor(java.lang.String,int,int)" class="member-name-link">ensureDivisor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int number, |
| int divisor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that a given value is a divisor of specified number.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#ensureExpectedCount(java.lang.String,int,int)" class="member-name-link">ensureExpectedCount</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| int actual)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Renamed <a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(String, boolean, int, int, int)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureFinite(java.lang.String,double)" class="member-name-link">ensureFinite</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isNaN(double)" title="class or interface in java.lang" class="external-link">NaN</a> neither <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isInfinite(double)" title="class or interface in java.lang" class="external-link">Double.isInfinite(double)</a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureFinite(java.lang.String,float)" class="member-name-link">ensureFinite</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isNaN(float)" title="class or interface in java.lang" class="external-link">NaN</a> neither <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isInfinite(float)" title="class or interface in java.lang" class="external-link">Float.isInfinite(float)</a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureMultiple(java.lang.String,int,int)" class="member-name-link">ensureMultiple</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int number, |
| int multiple)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that a given value is a multiple of specified number.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#ensureNonEmpty(java.lang.String,int%5B%5D,int,int,boolean)" class="member-name-link">ensureNonEmpty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int[] values, |
| int min, |
| int max, |
| boolean distinct)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Replaced by <a href="#ensureNonEmptyBounded(java.lang.String,boolean,int,int,int%5B%5D)"><code>ensureNonEmptyBounded(String, boolean, int, int, int[])</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonEmpty(java.lang.String,java.lang.CharSequence)" class="member-name-link">ensureNonEmpty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> text)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Makes sure that a character sequence is non-null and non-empty.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonEmpty(java.lang.String,java.lang.Object%5B%5D)" class="member-name-link">ensureNonEmpty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[] array)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Makes sure that an array is non-null and non-empty.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonEmpty(java.lang.String,java.util.Collection)" class="member-name-link">ensureNonEmpty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><?> toCheck)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Makes sure that given collection is non-null and non-empty.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonEmpty(java.lang.String,org.apache.sis.util.Emptiable)" class="member-name-link">ensureNonEmpty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a> toCheck)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Makes sure that given object is non-null and non-empty.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonEmptyBounded(java.lang.String,boolean,int,int,int%5B%5D)" class="member-name-link">ensureNonEmptyBounded</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean distinct, |
| int min, |
| int max, |
| int[] values)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given <code>values</code> array contains at least one element and that all elements are within bounds.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonNull(java.lang.String,java.lang.Object)" class="member-name-link">ensureNonNull</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Makes sure that an argument is non-null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureNonNullElement(java.lang.String,int,java.lang.Object)" class="member-name-link">ensureNonNullElement</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int index, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> element)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Makes sure that an array element is non-null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensurePositive(java.lang.String,double)" class="member-name-link">ensurePositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isNaN(double)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than or equals to zero.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensurePositive(java.lang.String,float)" class="member-name-link">ensurePositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isNaN(float)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than or equals to zero.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensurePositive(java.lang.String,int)" class="member-name-link">ensurePositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given integer value is greater than or equals to zero.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensurePositive(java.lang.String,long)" class="member-name-link">ensurePositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given long value is greater than or equals to zero.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#ensureSizeBetween(java.lang.String,int,int,int)" class="member-name-link">ensureSizeBetween</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int min, |
| int max, |
| int size)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Renamed <a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(String, boolean, int, int, int)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureStrictlyPositive(java.lang.String,double)" class="member-name-link">ensureStrictlyPositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isNaN(double)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than zero.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureStrictlyPositive(java.lang.String,float)" class="member-name-link">ensureStrictlyPositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isNaN(float)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than zero.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureStrictlyPositive(java.lang.String,int)" class="member-name-link">ensureStrictlyPositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given integer value is greater than zero.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureStrictlyPositive(java.lang.String,long)" class="member-name-link">ensureStrictlyPositive</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given long value is greater than zero.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureValidIndex(int,int)" class="member-name-link">ensureValidIndex</a><wbr>(int upper, |
| int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given index is equal or greater than zero and lower than the given |
| upper value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureValidIndexRange(int,int,int)" class="member-name-link">ensureValidIndexRange</a><wbr>(int length, |
| int lower, |
| int upper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given index range is valid for a sequence of the given length.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ensureValidUnicodeCodePoint(java.lang.String,int)" class="member-name-link">ensureValidUnicodeCodePoint</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int code)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Ensures that the given integer is a valid Unicode code point.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ensureNonNull(java.lang.String,java.lang.Object)"> |
| <h3>ensureNonNull</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonNull</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</span> |
| throws <span class="exceptions"><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></span></div> |
| <div class="block">Makes sure that an argument is non-null. If the given <code>object</code> is null, then a |
| <a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a> is thrown with a localized message containing the given name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>object</code> - the user argument to check against null value.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>object</code> is null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonNullElement(java.lang.String,int,java.lang.Object)"> |
| <h3>ensureNonNullElement</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonNullElement</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int index, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> element)</span> |
| throws <span class="exceptions"><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></span></div> |
| <div class="block">Makes sure that an array element is non-null. If <code>element</code> is null, then a |
| <a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a> is thrown with a localized message containing the |
| given name and index. The name and index are formatted as below: |
| |
| <ul> |
| <li>If the <code>name</code> contains the <code>"[#]"</code> sequence of characters, then the <code>'#'</code> character |
| is replaced by the <code>index</code> value. For example if <code>name</code> is <code>"axes[#].unit"</code> and the |
| index is 2, then the formatted message will contain <code>"axes[2].unit"</code>.</li> |
| <li>If the <code>name</code> does not contain the <code>"[#]"</code> sequence of characters, then <code>index</code> value |
| is appended between square brackets. For example if <code>name</code> is <code>"axes"</code> and the index is 2, |
| then the formatted message will contain <code>"axes[2]"</code>.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>index</code> - the Index of the element to check in an array or a list. Used only if an exception is thrown.</dd> |
| <dd><code>element</code> - the array or list element to check against null value.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>element</code> is null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonEmpty(java.lang.String,java.lang.CharSequence)"> |
| <h3>ensureNonEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonEmpty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> text)</span> |
| throws <span class="exceptions"><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Makes sure that a character sequence is non-null and non-empty. If the given <code>text</code> is |
| null, then a <a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a> is thrown. Otherwise if the given <code>text</code> has |
| a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html#length()" title="class or interface in java.lang" class="external-link">length</a> equals to 0, then an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> |
| is thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>text</code> - the user argument to check against null value and empty sequences.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>text</code> is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>text</code> is empty.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonEmpty(java.lang.String,java.lang.Object[])"> |
| <h3>ensureNonEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonEmpty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[] array)</span> |
| throws <span class="exceptions"><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Makes sure that an array is non-null and non-empty. If the given <code>array</code> is null, |
| then a <a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a> is thrown. Otherwise if the array length is equal |
| to 0, then an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> is thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>array</code> - the user argument to check against null value and empty array.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>array</code> is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>array</code> is empty.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonEmpty(java.lang.String,java.util.Collection)"> |
| <h3>ensureNonEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonEmpty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><?> toCheck)</span></div> |
| <div class="block">Makes sure that given collection is non-null and non-empty. |
| If it is null, then a <a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a> is thrown. |
| Otherwise if it <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html#isEmpty()" title="class or interface in java.util" class="external-link">is empty</a>, then an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> is thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>toCheck</code> - the user argument to check against null value and empty collection.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>toCheck</code> is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>toCheck</code> is empty.</dd> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonEmpty(java.lang.String,org.apache.sis.util.Emptiable)"> |
| <h3>ensureNonEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonEmpty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a> toCheck)</span></div> |
| <div class="block">Makes sure that given object is non-null and non-empty. |
| If it is null, then a <a href="NullArgumentException.html" title="class in org.apache.sis.util"><code>NullArgumentException</code></a> is thrown. |
| Otherwise if it <a href="Emptiable.html#isEmpty()">is empty</a>, then an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> is thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>toCheck</code> - the user argument to check against null value and empty object.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>toCheck</code> is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>toCheck</code> is empty.</dd> |
| <dt>Since:</dt> |
| <dd>1.4</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonEmpty(java.lang.String,int[],int,int,boolean)"> |
| <h3>ensureNonEmpty</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.3", |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#forRemoval()" title="class or interface in java.lang" class="external-link">forRemoval</a>=true) |
| </span><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonEmpty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int[] values, |
| int min, |
| int max, |
| boolean distinct)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Replaced by <a href="#ensureNonEmptyBounded(java.lang.String,boolean,int,int,int%5B%5D)"><code>ensureNonEmptyBounded(String, boolean, int, int, int[])</code></a>.</div> |
| </div> |
| <div class="block">Ensures that the given <code>values</code> array is non-null and non-empty. This method can also ensures that all values |
| are between the given bounds (inclusive) and are distinct. The distinct values requirement is useful for validating |
| arrays of spatiotemporal dimension indices, where dimensions cannot be repeated. |
| |
| <p>Note that a successful call to <code>ensureNonEmpty(name, values, 0, max, true)</code> implies |
| 1 ≤ <code>values.length</code> ≤ <code>max</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>values</code> - integer values to validate.</dd> |
| <dd><code>min</code> - the minimal allowed value (inclusive), or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html#MIN_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MIN_VALUE</code></a> if none.</dd> |
| <dd><code>max</code> - the maximal allowed value (inclusive), or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if none.</dd> |
| <dd><code>distinct</code> - <code>true</code> if each value must be unique.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>values</code> is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>values</code> is empty, contains a value lower than <code>min</code>, |
| contains a value greater than <code>max</code>, or contains duplicated values while <code>distinct</code> is <code>true</code>.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureNonEmptyBounded(java.lang.String,boolean,int,int,int[])"> |
| <h3>ensureNonEmptyBounded</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureNonEmptyBounded</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean distinct, |
| int min, |
| int max, |
| int[] values)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given <code>values</code> array contains at least one element and that all elements are within bounds. |
| The minimum and maximum values are inclusive. Optionaly, this method can also ensure that all values are distinct. |
| |
| <p>Note that a successful call to <code>ensureNonEmptyBounded(name, true, 0, max, values)</code> |
| implies 1 ≤ <code>values.length</code> ≤ <code>max</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>distinct</code> - <code>true</code> if each value must be unique.</dd> |
| <dd><code>min</code> - the minimal allowed value (inclusive), or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html#MIN_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MIN_VALUE</code></a> if none.</dd> |
| <dd><code>max</code> - the maximal allowed value (inclusive), or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if none.</dd> |
| <dd><code>values</code> - integer values to validate.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>values</code> is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>values</code> is empty, contains a value lower than <code>min</code>, |
| contains a value greater than <code>max</code>, or contains duplicated values while <code>distinct</code> is <code>true</code>.</dd> |
| <dt>Since:</dt> |
| <dd>1.4</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureExpectedCount(java.lang.String,int,int)"> |
| <h3>ensureExpectedCount</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.3", |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#forRemoval()" title="class or interface in java.lang" class="external-link">forRemoval</a>=true) |
| </span><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureExpectedCount</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| int actual)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Renamed <a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(String, boolean, int, int, int)</code></a>.</div> |
| </div> |
| <div class="block">Ensures that a method receiving a variable number of arguments got the expected count. |
| If <code>actual</code> = <code>expected</code>, then this method does nothing. |
| Otherwise an exception saying "Too few" or "Too many arguments" is thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - expected number of arguments.</dd> |
| <dd><code>actual</code> - actual number of arguments.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureCanCast(java.lang.String,java.lang.Class,java.lang.Object)"> |
| <h3>ensureCanCast</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureCanCast</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> expectedType, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the specified value is null or an instance assignable to the given type. |
| If this method does not thrown an exception, then the value can be casted to the class |
| represented by <code>expectedType</code> without throwing a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link"><code>ClassCastException</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown. |
| Can be <code>null</code> if the name is unknown.</dd> |
| <dd><code>expectedType</code> - the expected type (class or interface).</dd> |
| <dd><code>value</code> - the value to check, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>value</code> is non-null and is not assignable to the given type.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="collection/Containers.html#property(java.util.Map,java.lang.Object,java.lang.Class)"><code>Containers.property(Map, Object, Class)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureValidIndex(int,int)"> |
| <h3>ensureValidIndex</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureValidIndex</span><wbr><span class="parameters">(int upper, |
| int index)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></span></div> |
| <div class="block">Ensures that the given index is equal or greater than zero and lower than the given |
| upper value. This method is designed for methods that expect an index value as the only |
| argument. For this reason, this method does not take the argument name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>upper</code> - the maximal index value, exclusive.</dd> |
| <dd><code>index</code> - the index to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given index is negative or not lower than the given upper value.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensurePositive(java.lang.String,int)"><code>ensurePositive(String, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureValidIndexRange(int,int,int)"> |
| <h3>ensureValidIndexRange</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureValidIndexRange</span><wbr><span class="parameters">(int length, |
| int lower, |
| int upper)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></span></div> |
| <div class="block">Ensures that the given index range is valid for a sequence of the given length. |
| This method is designed for methods that expect an index range as their only arguments. |
| For this reason, this method does not take argument names. |
| |
| <p>This method verifies only the <code>lower</code> and <code>upper</code> argument values. |
| It does not <strong>not</strong> verify the validity of the <code>length</code> argument, |
| because this information is assumed to be provided by the implementation rather than |
| the user.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - the length of the sequence (array, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link"><code>CharSequence</code></a>, <i>etc.</i>).</dd> |
| <dd><code>lower</code> - the user-specified lower index, inclusive.</dd> |
| <dd><code>upper</code> - the user-specified upper index, exclusive.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given [<code>lower</code> … <code>upper</code>] |
| range is out of the sequence index range.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(String, boolean, int, int, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensurePositive(java.lang.String,int)"> |
| <h3>ensurePositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensurePositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given integer value is greater than or equals to zero. |
| This method is used for checking values that are <strong>not</strong> index. |
| For checking index values, use <a href="#ensureValidIndex(int,int)"><code>ensureValidIndex(int, int)</code></a> instead.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is negative.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureValidIndex(int,int)"><code>ensureValidIndex(int, int)</code></a></li> |
| <li><a href="#ensureStrictlyPositive(java.lang.String,int)"><code>ensureStrictlyPositive(String, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensurePositive(java.lang.String,long)"> |
| <h3>ensurePositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensurePositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given long value is greater than or equals to zero.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is negative.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureStrictlyPositive(java.lang.String,long)"><code>ensureStrictlyPositive(String, long)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensurePositive(java.lang.String,float)"> |
| <h3>ensurePositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensurePositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isNaN(float)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than or equals to zero. Note that |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#POSITIVE_INFINITY" title="class or interface in java.lang" class="external-link">positive infinity</a> is considered a valid value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN or negative.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureStrictlyPositive(java.lang.String,float)"><code>ensureStrictlyPositive(String, float)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensurePositive(java.lang.String,double)"> |
| <h3>ensurePositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensurePositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isNaN(double)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than or equals to zero. Note that |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#POSITIVE_INFINITY" title="class or interface in java.lang" class="external-link">positive infinity</a> is considered a valid value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN or negative.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureStrictlyPositive(java.lang.String,double)"><code>ensureStrictlyPositive(String, double)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureStrictlyPositive(java.lang.String,int)"> |
| <h3>ensureStrictlyPositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureStrictlyPositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given integer value is greater than zero.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is negative or equals to zero.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensurePositive(java.lang.String,int)"><code>ensurePositive(String, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureStrictlyPositive(java.lang.String,long)"> |
| <h3>ensureStrictlyPositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureStrictlyPositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given long value is greater than zero.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is negative or equals to zero.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensurePositive(java.lang.String,long)"><code>ensurePositive(String, long)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureStrictlyPositive(java.lang.String,float)"> |
| <h3>ensureStrictlyPositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureStrictlyPositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isNaN(float)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than zero. Note that |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#POSITIVE_INFINITY" title="class or interface in java.lang" class="external-link">positive infinity</a> is considered a valid value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN, zero or negative.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensurePositive(java.lang.String,float)"><code>ensurePositive(String, float)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureStrictlyPositive(java.lang.String,double)"> |
| <h3>ensureStrictlyPositive</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureStrictlyPositive</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isNaN(double)" title="class or interface in java.lang" class="external-link">NaN</a> and is greater than zero. Note that |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#POSITIVE_INFINITY" title="class or interface in java.lang" class="external-link">positive infinity</a> is considered a valid value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN, zero or negative.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensurePositive(java.lang.String,double)"><code>ensurePositive(String, double)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureFinite(java.lang.String,float)"> |
| <h3>ensureFinite</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureFinite</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float value)</span></div> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isNaN(float)" title="class or interface in java.lang" class="external-link">NaN</a> neither <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Float.html#isInfinite(float)" title="class or interface in java.lang" class="external-link">Float.isInfinite(float)</a>. |
| The value can be negative, zero or positive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN or infinite.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureFinite(java.lang.String,double)"> |
| <h3>ensureFinite</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureFinite</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double value)</span></div> |
| <div class="block">Ensures that the given floating point value is not |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isNaN(double)" title="class or interface in java.lang" class="external-link">NaN</a> neither <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#isInfinite(double)" title="class or interface in java.lang" class="external-link">Double.isInfinite(double)</a>. |
| The value can be negative, zero or positive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked, used only if an exception is thrown.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN or infinite.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureBetween(java.lang.String,int,int,int)"> |
| <h3>ensureBetween</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureBetween</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int min, |
| int max, |
| int value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given integer value is between the given bounds, inclusive. |
| This is a general-purpose method for checking integer arguments. |
| Note that the following specialized methods are provided for common kinds |
| of integer range checks: |
| |
| <ul> |
| <li><a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(…)</code></a> |
| if the <code>value</code> argument is a collection size or an array length.</li> |
| <li><a href="#ensureValidIndex(int,int)"><code>ensureValidIndex(…)</code></a> if the <code>value</code> |
| argument is an index in a list or an array.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>min</code> - the minimal value, inclusive.</dd> |
| <dd><code>max</code> - the maximal value, inclusive.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is not in the given range.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(String, boolean, int, int, int)</code></a></li> |
| <li><a href="#ensureValidIndex(int,int)"><code>ensureValidIndex(int, int)</code></a></li> |
| <li><a href="#ensureValidIndexRange(int,int,int)"><code>ensureValidIndexRange(int, int, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureBetween(java.lang.String,long,long,long)"> |
| <h3>ensureBetween</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureBetween</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long min, |
| long max, |
| long value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given long value is between the given bounds, inclusive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>min</code> - the minimal value, inclusive.</dd> |
| <dd><code>max</code> - the maximal value, inclusive.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is not in the given range.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureBetween(java.lang.String,float,float,float)"> |
| <h3>ensureBetween</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureBetween</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| float min, |
| float max, |
| float value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given floating point value is between the given bounds, inclusive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>min</code> - the minimal value, inclusive.</dd> |
| <dd><code>max</code> - the maximal value, inclusive.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN or not in the given range.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureBetween(java.lang.String,double,double,double)"> |
| <h3>ensureBetween</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureBetween</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| double min, |
| double max, |
| double value)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given floating point value is between the given bounds, inclusive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>min</code> - the minimal value, inclusive.</dd> |
| <dd><code>max</code> - the maximal value, inclusive.</dd> |
| <dd><code>value</code> - the user argument to check.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is NaN or not in the given range.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureSizeBetween(java.lang.String,int,int,int)"> |
| <h3>ensureSizeBetween</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.3", |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#forRemoval()" title="class or interface in java.lang" class="external-link">forRemoval</a>=true) |
| </span><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureSizeBetween</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int min, |
| int max, |
| int size)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Renamed <a href="#ensureCountBetween(java.lang.String,boolean,int,int,int)"><code>ensureCountBetween(String, boolean, int, int, int)</code></a>.</div> |
| </div> |
| <div class="block">Ensures that the given collection size or array length is between the given bounds, inclusive. |
| This method performs the same check than <a href="#ensureBetween(java.lang.String,int,int,int)"><code>ensureBetween(…)</code></a>, but the error message is different in case of failure.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>min</code> - the minimal size (inclusive), or 0 if none.</dd> |
| <dd><code>max</code> - the maximal size (inclusive), or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if none.</dd> |
| <dd><code>size</code> - the user collection size or array length to be checked.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is not in the given range.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureCountBetween(java.lang.String,boolean,int,int,int)"> |
| <h3>ensureCountBetween</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureCountBetween</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean named, |
| int min, |
| int max, |
| int count)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given number of elements is between the given bounds, inclusive. |
| This method performs the same check than <a href="#ensureBetween(java.lang.String,int,int,int)"><code>ensureBetween(…)</code></a>, but the error message is different in case of failure.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>named</code> - whether to use <code>name</code> as the name of a collection or array argument.</dd> |
| <dd><code>min</code> - the minimal size (inclusive), or 0 if none.</dd> |
| <dd><code>max</code> - the maximal size (inclusive), or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if none.</dd> |
| <dd><code>count</code> - the number of user-specified arguments, collection size or array length to be checked.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is not in the given range.</dd> |
| <dt>Since:</dt> |
| <dd>1.4</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#ensureBetween(java.lang.String,int,int,int)"><code>ensureBetween(String, int, int, int)</code></a></li> |
| <li><a href="#ensureValidIndexRange(int,int,int)"><code>ensureValidIndexRange(int, int, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureValidUnicodeCodePoint(java.lang.String,int)"> |
| <h3>ensureValidUnicodeCodePoint</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureValidUnicodeCodePoint</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int code)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Ensures that the given integer is a valid Unicode code point. The range of valid code points goes |
| from <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Character.html#MIN_CODE_POINT" title="class or interface in java.lang" class="external-link"><code>U+0000</code></a> to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Character.html#MAX_CODE_POINT" title="class or interface in java.lang" class="external-link"><code>U+10FFFF</code></a> inclusive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>code</code> - the Unicode code point to verify.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is not a valid Unicode code point.</dd> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDivisor(java.lang.String,int,int)"> |
| <h3>ensureDivisor</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDivisor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int number, |
| int divisor)</span></div> |
| <div class="block">Ensures that a given value is a divisor of specified number. |
| This method verifies that <code>(number % divisor) == 0</code>. |
| If above condition is not met, the value considered to be wrong is the divisor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the argument for the divisor value. Used only if an exception is thrown.</dd> |
| <dd><code>number</code> - the number to be divided.</dd> |
| <dd><code>divisor</code> - the value to verify.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>(number % divisor) != 0</code>.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link">ArithmeticException</a></code> - if <code>divisor == 0</code>.</dd> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureMultiple(java.lang.String,int,int)"> |
| <h3>ensureMultiple</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureMultiple</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int number, |
| int multiple)</span></div> |
| <div class="block">Ensures that a given value is a multiple of specified number. |
| This method verifies that <code>(multiple % number) == 0</code>. |
| If above condition is not met, the value considered to be wrong is the multiple.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the argument for the multiple value. Used only if an exception is thrown.</dd> |
| <dd><code>number</code> - the number to be multiplied.</dd> |
| <dd><code>multiple</code> - the value to verify.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>(multiple % number) != 0</code>.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link">ArithmeticException</a></code> - if <code>number == 0</code>.</dd> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionMatches(java.lang.String,int,org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>ensureDimensionMatches</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionMatches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given CRS, if non-null, has the expected number of dimensions. |
| This method does nothing if the given coordinate reference system is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - the expected number of dimensions.</dd> |
| <dd><code>crs</code> - the coordinate reference system to check for its dimension, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given coordinate reference system is non-null |
| and does not have the expected number of dimensions.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionMatches(java.lang.String,int,org.opengis.referencing.cs.CoordinateSystem)"> |
| <h3>ensureDimensionMatches</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionMatches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">CoordinateSystem</a> cs)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given coordinate system, if non-null, has the expected number of dimensions. |
| This method does nothing if the given coordinate system is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - the expected number of dimensions.</dd> |
| <dd><code>cs</code> - the coordinate system to check for its dimension, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given coordinate system is non-null |
| and does not have the expected number of dimensions.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionMatches(java.lang.String,int,int[])"> |
| <h3>ensureDimensionMatches</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionMatches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| int[] indices)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given array of indices, if non-null, has the expected number of dimensions |
| (taken as its length). This method does nothing if the given array is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - the expected number of dimensions.</dd> |
| <dd><code>indices</code> - the array of indices to check for its number of dimensions, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given array of indices is non-null and does not have |
| the expected number of dimensions (taken as its length).</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionMatches(java.lang.String,int,double[])"> |
| <h3>ensureDimensionMatches</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionMatches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| double[] vector)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given vector, if non-null, has the expected number of dimensions |
| (taken as its length). This method does nothing if the given vector is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - the expected number of dimensions.</dd> |
| <dd><code>vector</code> - the vector to check for its number of dimensions, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given vector is non-null and does not have the |
| expected number of dimensions (taken as its length).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionMatches(java.lang.String,int,org.opengis.geometry.DirectPosition)"> |
| <h3>ensureDimensionMatches</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionMatches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a> position)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given direct position, if non-null, has the expected number of dimensions. |
| This method does nothing if the given direct position is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - the expected number of dimensions.</dd> |
| <dd><code>position</code> - the direct position to check for its dimension, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given direct position is non-null and does |
| not have the expected number of dimensions.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionMatches(java.lang.String,int,org.opengis.geometry.Envelope)"> |
| <h3>ensureDimensionMatches</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionMatches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expected, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a> envelope)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given envelope, if non-null, has the expected number of dimensions. |
| This method does nothing if the given envelope is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expected</code> - the expected number of dimensions.</dd> |
| <dd><code>envelope</code> - the envelope to check for its dimension, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given envelope is non-null and does |
| not have the expected number of dimensions.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureDimensionsMatch(java.lang.String,int,int,org.opengis.referencing.operation.MathTransform)"> |
| <h3>ensureDimensionsMatch</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">ensureDimensionsMatch</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int expectedSource, |
| int expectedTarget, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a> transform)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></span></div> |
| <div class="block">Ensures that the given transform, if non-null, has the expected number of source and target dimensions. |
| This method does nothing if the given transform is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the argument to be checked. Used only if an exception is thrown.</dd> |
| <dd><code>expectedSource</code> - the expected number of source dimensions.</dd> |
| <dd><code>expectedTarget</code> - the expected number of target dimensions.</dd> |
| <dd><code>transform</code> - the transform to check for its dimension, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if the given transform is non-null and does |
| not have the expected number of dimensions.</dd> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |