| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>org.apache.sis.util (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.util package"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.sis.util (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sis.util</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Simple data objects and miscellaneous utilities. |
| This package provides general purpose static methods working on primitive or basic Java types |
| (<a href="Characters.html" title="class in org.apache.sis.util"><code>Characters</code></a>, |
| <a href="CharSequences.html" title="class in org.apache.sis.util"><code>CharSequences</code></a>, |
| <a href="StringBuilders.html" title="class in org.apache.sis.util"><code>StringBuilders</code></a>, |
| <a href="Locales.html" title="class in org.apache.sis.util"><code>Locales</code></a>, |
| <a href="Numbers.html" title="class in org.apache.sis.util"><code>Numbers</code></a>, |
| <a href="Classes.html" title="class in org.apache.sis.util"><code>Classes</code></a>), arrays |
| (<a href="ArraysExt.html" title="class in org.apache.sis.util"><code>ArraysExt</code></a>) or other standard Java types |
| (<a href="Exceptions.html" title="class in org.apache.sis.util"><code>Exceptions</code></a>). |
| |
| It defines also general purpose annotations, enumerations and exceptions. |
| |
| <p>Some other noticeable services are:</p> |
| <ul> |
| <li><a href="ObjectConverters.html" title="class in org.apache.sis.util"><code>ObjectConverters</code></a>, together with the |
| <a href="ObjectConverter.html" title="interface in org.apache.sis.util"><code>ObjectConverter</code></a> interface, for converting various kinds of objects.</li> |
| <li><a href="Utilities.html" title="class in org.apache.sis.util"><code>Utilities</code></a>, together with the |
| <a href="LenientComparable.html" title="interface in org.apache.sis.util"><code>LenientComparable</code></a> interface, for comparing objects in various ways.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></th> |
| <td class="colLast"> |
| <div class="block">Interface of classes for which deprecated instances may exist.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Disposable.html" title="interface in org.apache.sis.util">Disposable</a></th> |
| <td class="colLast"> |
| <div class="block">A resource that can be disposed when waiting for the garbage collector would be overly conservative.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></th> |
| <td class="colLast"> |
| <div class="block">Interface of classes for which empty instances may exist.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></th> |
| <td class="colLast"> |
| <div class="block">Interfaces of classes for which instances can be compared for equality using different levels of strictness.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Localized.html" title="interface in org.apache.sis.util">Localized</a></th> |
| <td class="colLast"> |
| <div class="block">Interface of classes for which each instance is configured for a particular locale.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="LocalizedException.html" title="interface in org.apache.sis.util">LocalizedException</a></th> |
| <td class="colLast"> |
| <div class="block">An exception which can produce an error message in the client locale.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ObjectConverter.html" title="interface in org.apache.sis.util">ObjectConverter</a><S,​T></th> |
| <td class="colLast"> |
| <div class="block">A function which converts instances of <var>source</var> type to instances of <var>target</var> type.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ArgumentChecks.html" title="class in org.apache.sis.util">ArgumentChecks</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods for performing argument checks.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ArraysExt.html" title="class in org.apache.sis.util">ArraysExt</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods for simple operations on arrays and array elements.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Characters.html" title="class in org.apache.sis.util">Characters</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working on <code>char</code> values, and some character constants.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Characters.Filter.html" title="class in org.apache.sis.util">Characters.Filter</a></th> |
| <td class="colLast"> |
| <div class="block">Subsets of Unicode characters identified by their general category.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CharSequences.html" title="class in org.apache.sis.util">CharSequences</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>CharSequence</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Classes.html" title="class in org.apache.sis.util">Classes</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working on <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Class</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Exceptions.html" title="class in org.apache.sis.util">Exceptions</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Exception</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Locales.html" title="class in org.apache.sis.util">Locales</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Locale</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Numbers.html" title="class in org.apache.sis.util">Numbers</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Number</code></a> objects, and a few primitive types by extension.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ObjectConverters.html" title="class in org.apache.sis.util">ObjectConverters</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods for creating <a href="ObjectConverter.html" title="interface in org.apache.sis.util"><code>ObjectConverter</code></a> instances or collection views based on converters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Static.html" title="class in org.apache.sis.util">Static</a></th> |
| <td class="colLast"> |
| <div class="block">Parent of SIS classes that contain only static utility methods, for documentation purpose.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="StringBuilders.html" title="class in org.apache.sis.util">StringBuilders</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods working on <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>StringBuilder</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Utilities.html" title="class in org.apache.sis.util">Utilities</a></th> |
| <td class="colLast"> |
| <div class="block">Static methods for object comparisons in different ways (deeply, approximately, <i>etc</i>).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Version.html" title="class in org.apache.sis.util">Version</a></th> |
| <td class="colLast"> |
| <div class="block">Holds a version number as a sequence of strings separated by either a dot or a dash.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a></th> |
| <td class="colLast"> |
| <div class="block">Specifies the level of strictness when comparing two <a href="LenientComparable.html" title="interface in org.apache.sis.util"><code>LenientComparable</code></a> objects |
| for equality.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CorruptedObjectException.html" title="class in org.apache.sis.util">CorruptedObjectException</a></th> |
| <td class="colLast"> |
| <div class="block">May be thrown on attempt to use an object which has been corrupted by a previous operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when a null argument has been given to a method that doesn't accept them.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="UnconvertibleObjectException.html" title="class in org.apache.sis.util">UnconvertibleObjectException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when an object can not be <a href="ObjectConverter.html#apply(S)">converted</a> |
| from the <cite>source</cite> type to the <cite>target</cite> type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="UnknownNameException.html" title="class in org.apache.sis.util">UnknownNameException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when an operation can not complete because a given name is unrecognized.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="UnsupportedImplementationException.html" title="class in org.apache.sis.util">UnsupportedImplementationException</a></th> |
| <td class="colLast"> |
| <div class="block">Thrown when an operation can not use arbitrary implementation of an interface, |
| and a given instance does not met the requirement.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Configuration.html" title="annotation in org.apache.sis.util">Configuration</a></th> |
| <td class="colLast"> |
| <div class="block">Annotates methods having a system-wide impact on the configuration of the Apache SIS library.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Debug.html" title="annotation in org.apache.sis.util">Debug</a></th> |
| <td class="colLast"> |
| <div class="block">Annotates classes or methods that are provided mostly for debugging purpose.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Workaround.html" title="annotation in org.apache.sis.util">Workaround</a></th> |
| <td class="colLast"> |
| <div class="block">Annotates code containing workarounds for bugs or limitations in an external library.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
