Google Git
Sign in
apache / sis-site / refs/heads/javadoc / . / org.apache.sis.util / org / apache / sis / util / package-summary.html
blob: a6775753b69937ddaafc200a7578d02470d9716a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>org.apache.sis.util (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="../../../../../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="package-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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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 class="nav-bar-cell1-rev">Package</li>
<li>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#package">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Package:</p>
<ul>
<li><a href="#package-description">Description</a></li>
<li><a href="#related-package-summary">Related Packages</a></li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<div class="sub-title"><span class="module-label-in-package">Module</span>&nbsp;<a href="../../../../module-summary.html">org.apache.sis.util</a></div>
<h1 title="Package org.apache.sis.util" class="title">Package org.apache.sis.util</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.sis.util</span></div>
<section class="package-description" id="package-description">
<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>Char­Sequences</code></a>,
<a href="StringBuilders.html" title="class in org.apache.sis.util"><code>String­Builders</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>Arrays­Ext</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>Object­Converters</code></a>, together with the
<a href="ObjectConverter.html" title="interface in org.apache.sis.util"><code>Object­Converter</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>Lenient­Comparable</code></a> interface, for comparing objects in various ways.</li>
</ul></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.3</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Module</div>
<div class="table-header col-second">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-plain even-row-color"><a href="../../../../module-summary.html">org.apache.sis.util</a></div>
<div class="col-first even-row-color"><a href="collection/package-summary.html">org.apache.sis.util.collection</a></div>
<div class="col-last even-row-color">
<div class="block">Addition to the collection framework.</div>
</div>
<div class="col-plain odd-row-color"><a href="../../../../../org.apache.sis.metadata/module-summary.html">org.apache.sis.metadata</a></div>
<div class="col-first odd-row-color"><a href="../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/package-summary.html">org.apache.sis.util.iso</a></div>
<div class="col-last odd-row-color">
<div class="block">Implementations of GeoAPI types from the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/package-summary.html" class="external-link"><code>org​.opengis​.util</code></a> package.</div>
</div>
<div class="col-plain even-row-color"><a href="../../../../module-summary.html">org.apache.sis.util</a></div>
<div class="col-first even-row-color"><a href="logging/package-summary.html">org.apache.sis.util.logging</a></div>
<div class="col-last even-row-color">
<div class="block">Extensions to the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/package-summary.html" class="external-link">JDK logging</a> framework.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exception Classes</button><button id="class-summary-tab6" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab6', 2)" class="table-tab">Annotation Interfaces</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractInternationalString.html" title="class in org.apache.sis.util">AbstractInternationalString</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base class for character strings that has been internationalized into several locales.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArgumentChecks.html" title="class in org.apache.sis.util">ArgumentChecks</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Static methods for performing argument checks.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArraysExt.html" title="class in org.apache.sis.util">ArraysExt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Static methods for simple operations on arrays and array elements.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Characters.html" title="class in org.apache.sis.util">Characters</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Static methods working on <code>char</code> values, and some character constants.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Characters.Filter.html" title="class in org.apache.sis.util">Characters.Filter</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Subsets of Unicode characters identified by their general category.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CharSequences.html" title="class in org.apache.sis.util">CharSequences</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Static methods working with <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>Char­Sequence</code></a> instances.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Classes.html" title="class in org.apache.sis.util">Classes</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Static methods working on <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"><code>Class</code></a> objects.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Specifies the level of strictness when comparing two <a href="LenientComparable.html" title="interface in org.apache.sis.util"><code>Lenient­Comparable</code></a> objects
for equality.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="CorruptedObjectException.html" title="class in org.apache.sis.util">CorruptedObjectException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">May be thrown on attempt to use an object which has been corrupted by a previous operation.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab6"><a href="Debug.html" title="annotation interface in org.apache.sis.util">Debug</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab6">
<div class="block">Annotates classes or methods that are provided mostly for debugging purpose.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultInternationalString.html" title="class in org.apache.sis.util">DefaultInternationalString</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An international string using a map of strings for different locales.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface of classes for which deprecated instances may exist.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Disposable.html" title="interface in org.apache.sis.util">Disposable</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A resource that can be disposed when waiting for the garbage collector would be overly conservative.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface of classes for which empty instances may exist.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Exceptions.html" title="class in org.apache.sis.util">Exceptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Static methods working with <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link"><code>Exception</code></a> instances.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interfaces of classes for which instances can be compared for equality using different levels of strictness.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Locales.html" title="class in org.apache.sis.util">Locales</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Static methods working on <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link"><code>Locale</code></a> instances.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Localized.html" title="interface in org.apache.sis.util">Localized</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface of classes for which each instance is configured for a particular locale.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LocalizedException.html" title="interface in org.apache.sis.util">LocalizedException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">An exception which can produce an error message in the client locale.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">Deprecated, for removal: This API element is subject to removal in a future version.
<div class="deprecation-comment">This exception was introduced before Java introduced <code>Objects​.require­Non­Null(…)</code>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Numbers.html" title="class in org.apache.sis.util">Numbers</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Static methods working with <code>Number</code> objects, and a few primitive types by extension.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ObjectConverter.html" title="interface in org.apache.sis.util">ObjectConverter</a>&lt;S,<wbr>T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A function which converts instances of <var>source</var> type to instances of <var>target</var> type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ObjectConverters.html" title="class in org.apache.sis.util">ObjectConverters</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Static methods for creating <a href="ObjectConverter.html" title="interface in org.apache.sis.util"><code>Object­Converter</code></a> instances or collection views based on converters.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab6"><a href="OptionalCandidate.html" title="annotation interface in org.apache.sis.util">OptionalCandidate</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab6">
<div class="block">Marker annotation for methods which may return <code>java​.util​.Optional</code> in a future version.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ResourceInternationalString.html" title="class in org.apache.sis.util">ResourceInternationalString</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An international string backed by a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ResourceBundle.html" title="class or interface in java.util" class="external-link"><code>Resource­Bundle</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SimpleInternationalString.html" title="class in org.apache.sis.util">SimpleInternationalString</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An international string consisting of a single string for all locales.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Static.html" title="class in org.apache.sis.util">Static</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parent of SIS classes that contain only static utility methods.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StringBuilders.html" title="class in org.apache.sis.util">StringBuilders</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Static methods working on <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link"><code>String­Builder</code></a> instances.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="UnconvertibleObjectException.html" title="class in org.apache.sis.util">UnconvertibleObjectException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when an object cannot be <a href="ObjectConverter.html#apply(S)">converted</a>
from the <cite>source</cite> type to the <cite>target</cite> type.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="UnknownNameException.html" title="class in org.apache.sis.util">UnknownNameException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Thrown when an operation cannot complete because a given name is unrecognized.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="UnsupportedImplementationException.html" title="class in org.apache.sis.util">UnsupportedImplementationException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when an operation cannot use arbitrary implementation of an interface,
and a given instance does not met the requirement.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Utilities.html" title="class in org.apache.sis.util">Utilities</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Static methods for object comparisons in different ways (deeply, approximately, <i>etc</i>).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Version.html" title="class in org.apache.sis.util">Version</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Holds a version number as a sequence of strings separated by either a dot or a dash.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab6"><a href="Workaround.html" title="annotation interface in org.apache.sis.util">Workaround</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab6">
<div class="block">Annotates code containing workarounds for bugs or limitations in an external library.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
</div>
</div>
</body>
</html>