org/apache/sis/util/Utilities.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>Utilities (Apache SIS 1.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.sis.util, class: Utilities">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.util.Utilities class">
 <meta name="keywords" content="equalsIgnoreMetadata()">
 <meta name="keywords" content="equalsApproximately()">
 <meta name="keywords" content="deepEquals()">
 <meta name="keywords" content="deepHashCode()">
 <meta name="keywords" content="deepToString()">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&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="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/Utilities.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li>Nested</li>
 <li>Field</li>
 <li>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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.util</a></div>
 <h1 title="Class Utilities" class="title">Class Utilities</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance"><a href="Static.html" title="class in org.apache.sis.util">Static</a>
 <div class="inheritance">Utilities</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">Utilities</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 object comparisons in different ways (deeply, approximately, <i>etc</i>).</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.3</dd>

 <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
 </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></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 boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)" class="member-name-link">deepEquals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object1,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object2,
  <a href="ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a>&nbsp;mode)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Convenience method for testing two objects for equality using the given level of strictness.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deepHashCode(java.lang.Object)" class="member-name-link">deepHashCode</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a hash code for the specified object, which may be an array.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deepToString(java.lang.Object)" class="member-name-link">deepToString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns a string representation of the specified object, which may be an array.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equalsApproximately(java.lang.Object,java.lang.Object)" class="member-name-link">equalsApproximately</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object1,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object2)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Compares the specified objects for equality, ignoring metadata and slight differences
  in numerical values.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equalsIgnoreMetadata(java.lang.Object,java.lang.Object)" class="member-name-link">equalsIgnoreMetadata</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object1,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object2)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Compares the specified objects for equality, ignoring metadata.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </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="equalsIgnoreMetadata(java.lang.Object,java.lang.Object)">
 <h3>equalsIgnoreMetadata</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equalsIgnoreMetadata</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object1,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object2)</span></div>
 <div class="block">Compares the specified objects for equality, ignoring metadata.
  If this method returns <code>true</code>, then:

  <ul>
    <li>If the two given objects are
        <a href="../referencing/operation/transform/AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">math transforms</a>,
        then transforming a set of coordinate values using one transform will produce the same
        results than transforming the same coordinates with the other transform.</li>

    <li>If the two given objects are
        <a href="../referencing/crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference Systems</a> (CRS), then a call to
        <code><a href="../referencing/CRS.html#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)">findOperation</a>(crs1, crs2, null)</code>
        will return an identity operation.</li>
  </ul>

  If a more lenient comparison allowing slight differences in numerical values is wanted,
  then <a href="#equalsApproximately(java.lang.Object,java.lang.Object)"><code>equalsApproximately(Object, Object)</code></a> can be used instead.

  <h4>Implementation note</h4>
  This is a convenience method for the following method call:

  <blockquote><pre><font color="green">return</font> <b>deepEquals</b>(object1, object2, ComparisonMode.IGNORE_METADATA);</pre></blockquote></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>object1</code> - the first object to compare (may be null).</dd>
 <dd><code>object2</code> - the second object to compare (may be null).</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if both objects are equal, ignoring metadata.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>deepEquals(Object, Object, ComparisonMode)</code></a></li>
 <li><a href="ComparisonMode.html#IGNORE_METADATA"><code>ComparisonMode.IGNORE_METADATA</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="equalsApproximately(java.lang.Object,java.lang.Object)">
 <h3>equalsApproximately</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equalsApproximately</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object1,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object2)</span></div>
 <div class="block">Compares the specified objects for equality, ignoring metadata and slight differences
  in numerical values. If this method returns <code>true</code>, then:

  <ul>
    <li>If the two given objects are
        <a href="../referencing/operation/transform/AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">math transforms</a>,
        then transforming a set of coordinate values using one transform will produce <em>approximately</em>
        the same results than transforming the same coordinates with the other transform.</li>

    <li>If the two given objects are
        <a href="../referencing/crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference Systems</a> (CRS), then a call to
        <code><a href="../referencing/CRS.html#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)">findOperation</a>(crs1, crs2, null)</code>
        will return an operation close to identity.</li>
  </ul>

  <h4>Implementation note</h4>
  This is a convenience method for the following method call:

  <blockquote><pre><font color="green">return</font> <b>deepEquals</b>(object1, object2, ComparisonMode.APPROXIMATE);</pre></blockquote></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>object1</code> - the first object to compare (may be null).</dd>
 <dd><code>object2</code> - the second object to compare (may be null).</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if both objects are approximately equal.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>deepEquals(Object, Object, ComparisonMode)</code></a></li>
 <li><a href="ComparisonMode.html#APPROXIMATE"><code>ComparisonMode.APPROXIMATE</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)">
 <h3>deepEquals</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">deepEquals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object1,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object2,
  <a href="ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a>&nbsp;mode)</span></div>
 <div class="block">Convenience method for testing two objects for equality using the given level of strictness.
  If at least one of the given objects implement the <a href="LenientComparable.html" title="interface in org.apache.sis.util"><code>LenientComparable</code></a> interface, then
  the comparison is performed using the <a href="LenientComparable.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>LenientComparable.equals(Object, ComparisonMode)</code></a>
  method. Otherwise this method performs the same work than the
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Objects.html#deepEquals(java.lang.Object,java.lang.Object)" title="class or interface in java.util" class="external-link"><code>Objects.deepEquals(Object, Object)</code></a> convenience method.

  <p>If both arguments are arrays or collections, then the elements are compared recursively.</p></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>object1</code> - the first object to compare, or <code>null</code>.</dd>
 <dd><code>object2</code> - the second object to compare, or <code>null</code>.</dd>
 <dd><code>mode</code> - the strictness level of the comparison.</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if both objects are equal for the given level of strictness.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="#equalsIgnoreMetadata(java.lang.Object,java.lang.Object)"><code>equalsIgnoreMetadata(Object, Object)</code></a></li>
 <li><a href="#equalsApproximately(java.lang.Object,java.lang.Object)"><code>equalsApproximately(Object, Object)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="deepHashCode(java.lang.Object)">
 <h3>deepHashCode</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">deepHashCode</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object)</span></div>
 <div class="block">Returns a hash code for the specified object, which may be an array.
  This method returns one of the following values:

  <ul>
    <li>If the supplied object is <code>null</code>, then this method returns 0.</li>
    <li>Otherwise if the object is an array of objects, then
        <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html#deepHashCode(java.lang.Object%5B%5D)" title="class or interface in java.util" class="external-link"><code>Arrays.deepHashCode(Object[])</code></a> is invoked.</li>
    <li>Otherwise if the object is an array of primitive type, then the corresponding
        <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html#hashCode(double%5B%5D)" title="class or interface in java.util" class="external-link"><code>Arrays.hashCode(...)</code></a> method is invoked.</li>
    <li>Otherwise <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link"><code>Object.hashCode()</code></a> is invoked.</li>
  </ul>

  This method should be invoked <strong>only</strong> if the object type is declared
  exactly as <code>Object</code>, not as some subtype like <code>Object[]</code>, <code>String</code> or
  <code>float[]</code>. In the latter cases, use the appropriate <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html" title="class or interface in java.util" class="external-link"><code>Arrays</code></a> method instead.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>object</code> - the object to compute hash code. May be <code>null</code>.</dd>
 <dt>Returns:</dt>
 <dd>the hash code of the given object.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="deepToString(java.lang.Object)">
 <h3>deepToString</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">deepToString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;object)</span></div>
 <div class="block">Returns a string representation of the specified object, which may be an array.
  This method returns one of the following values:

  <ul>
    <li>If the object is an array of objects, then
        <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html#deepToString(java.lang.Object%5B%5D)" title="class or interface in java.util" class="external-link"><code>Arrays.deepToString(Object[])</code></a> is invoked.</li>
    <li>Otherwise if the object is an array of primitive type, then the corresponding
        <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html#toString(double%5B%5D)" title="class or interface in java.util" class="external-link"><code>Arrays.toString(...)</code></a> method is invoked.</li>
    <li>Otherwise <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html#valueOf(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>String.valueOf(Object)</code></a> is invoked.</li>
  </ul>

  This method should be invoked <strong>only</strong> if the object type is declared
  exactly as <code>Object</code>, not as some subtype like <code>Object[]</code>, <code>Number</code> or
  <code>float[]</code>. In the latter cases, use the appropriate <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Arrays.html" title="class or interface in java.util" class="external-link"><code>Arrays</code></a> method instead.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>object</code> - the object to format as a string. May be <code>null</code>.</dd>
 <dt>Returns:</dt>
 <dd>a string representation of the given object.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>