org.apache.sis.referencing/org/apache/sis/referencing/factory/IdentifiedObjectFinder.Domain.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
 <title>IdentifiedObjectFinder.Domain (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.referencing, package: org.apache.sis.referencing.factory, class: IdentifiedObjectFinder, enum: Domain">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.referencing.factory.IdentifiedObjectFinder.Domain class">
 <meta name="keywords" content="values()">
 <meta name="keywords" content="valueOf()">
 <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">&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><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><a href="#nested-class-summary">Nested</a></li>
 <li><a href="#enum-constant-summary">Enum Constants</a></li>
 <li>Field</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li><a href="#enum-constant-detail">Enum Constants</a></li>
 <li>Field</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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#enum-constant-summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#enum-constant-detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&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="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing.factory</a></div>
 <h1 title="Enum Class IdentifiedObjectFinder.Domain" class="title">Enum Class IdentifiedObjectFinder.Domain</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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a>&gt;
 <div class="inheritance">Domain</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a>&gt;</code>, <code>Constable</code></dd>
 </dl>
 <dl class="notes">
 <dt>Enclosing class:</dt>
 <dd><code><a href="IdentifiedObjectFinder.html" title="class in org.apache.sis.referencing.factory">IdentifiedObjectFinder</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">IdentifiedObjectFinder.Domain</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a>&gt;</span></div>
 <div class="block">The domain of the search (for example whether to include deprecated objects in the search).</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.7</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="IdentifiedObjectFinder.html#getSearchDomain()"><code>IdentifiedObjectFinder.getSearchDomain()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="inherited-list">
 <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>&gt;&gt;</code></div>
 </section>
 </li>
 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
 <li>
 <section class="constants-summary" id="enum-constant-summary">
 <h2>Enum Constant Summary</h2>
 <div class="caption"><span>Enum Constants</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Enum Constant</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code><a href="#ALL_DATASET" class="member-name-link">ALL_DATASET</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Lookup based on all objects (both valid and deprecated) known to the factory.</div>
 </div>
 <div class="col-first odd-row-color"><code><a href="#DECLARATION" class="member-name-link">DECLARATION</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Fast lookup based only on embedded identifiers and names.</div>
 </div>
 <div class="col-first even-row-color"><code><a href="#EXHAUSTIVE_VALID_DATASET" class="member-name-link">EXHAUSTIVE_VALID_DATASET</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Lookup unconditionally based on all valid (non-deprecated) objects known to the factory.</div>
 </div>
 <div class="col-first odd-row-color"><code><a href="#VALID_DATASET" class="member-name-link">VALID_DATASET</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Lookup based on valid (non-deprecated) objects known to the factory.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== 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 <a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</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>&nbsp;name)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the enum constant of this class with the specified name.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a>[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns an array containing the constants of this enum class, in
 the order they are declared.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Enum">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.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/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.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/Enum.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/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.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/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.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/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></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/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#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#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#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">
 <!-- ============ ENUM CONSTANT DETAIL =========== -->
 <li>
 <section class="constant-details" id="enum-constant-detail">
 <h2>Enum Constant Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="DECLARATION">
 <h3>DECLARATION</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></span>&nbsp;<span class="element-name">DECLARATION</span></div>
 <div class="block">Fast lookup based only on embedded identifiers and names. If those identification information
  does not allow to locate an object in the factory, then the search will return an empty set.

  <h4 id="example-heading">Example</h4>
  If <a href="IdentifiedObjectFinder.html#find(org.opengis.referencing.IdentifiedObject)"><code>IdentifiedObjectFinder.find(IdentifiedObject)</code></a> is invoked with an object having the <code>"4326"</code>
  <a href="../AbstractIdentifiedObject.html#getIdentifiers()">identifier</a>, then the <code>find(…)</code> method will invoke
  <code>factory.<a href="GeodeticAuthorityFactory.html#createGeographicCRS(java.lang.String)">createGeographicCRS</a>("4326")</code>
  and compare the object from the factory with the object to search.
  If the objects do not match, then another attempt will be done using the
  <a href="../AbstractIdentifiedObject.html#getName()">object name</a>. If using name does not work neither,
  then <code>find(…)</code> method makes no other attempt and returns an empty set.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="VALID_DATASET">
 <h3>VALID_DATASET</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></span>&nbsp;<span class="element-name">VALID_DATASET</span></div>
 <div class="block">Lookup based on valid (non-deprecated) objects known to the factory.
  First, a fast lookup is performed based on <a href="#DECLARATION"><code>DECLARATION</code></a>.
  If the fast lookup gave no result, then a more extensive search is performed by scanning the content
  of the dataset.

  <h4 id="example-heading1">Example</h4>
  If <a href="IdentifiedObjectFinder.html#find(org.opengis.referencing.IdentifiedObject)"><code>IdentifiedObjectFinder.find(IdentifiedObject)</code></a> is invoked with an object equivalent to the
  <a href="../CommonCRS.html#WGS84">WGS84</a> geographic CRS but does not declare the
  <code>"4326"</code> identifier and does not have the <cite>"WGS 84"</cite> name, then the search based on
  <a href="#DECLARATION"><code>DECLARATION</code></a> will give no result. The <code>find(…)</code> method will then scan the dataset for
  geographic CRS using equivalent datum and coordinate system. This may be a costly operation.

  This is the default domain of <a href="IdentifiedObjectFinder.html" title="class in org.apache.sis.referencing.factory"><code>IdentifiedObjectFinder</code></a>.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="EXHAUSTIVE_VALID_DATASET">
 <h3>EXHAUSTIVE_VALID_DATASET</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></span>&nbsp;<span class="element-name">EXHAUSTIVE_VALID_DATASET</span></div>
 <div class="block">Lookup unconditionally based on all valid (non-deprecated) objects known to the factory.
  This is similar to <a href="#VALID_DATASET"><code>VALID_DATASET</code></a> except that the fast <a href="#DECLARATION"><code>DECLARATION</code></a> lookup is skipped.
  Instead, a potentially costly scan of the database is unconditionally performed
  (unless the result is already in the cache).

  <p>This domain can be useful when the search <a href="IdentifiedObjectFinder.html#isIgnoringAxes()">ignores axis order</a>.
  If axis order is <em>not</em> ignored, then this domain usually has no advantage over <a href="#VALID_DATASET"><code>VALID_DATASET</code></a>
  (unless the geodetic dataset contains duplicated entries) to justify the performance cost.</p>

  <h4 id="use-case-heading">Use case</h4>
  The EPSG database sometimes contains two definitions for almost identical geographic CRS,
  one with (<var>latitude</var>, <var>longitude</var>) axis order and one with reverse order
  (e.g. EPSG::4171 versus EPSG::7084). It is sometimes useful to know all variants of a given CRS.
  The <a href="#VALID_DATASET"><code>VALID_DATASET</code></a> domain may not give a complete set because the "fast lookup by identifier"
  optimization may prevent <a href="IdentifiedObjectFinder.html" title="class in org.apache.sis.referencing.factory"><code>IdentifiedObjectFinder</code></a> to scan the rest of the database.
  This <code>EXHAUSTIVE_VALID_DATASET</code> domain forces such scan.</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.2</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="ALL_DATASET">
 <h3>ALL_DATASET</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></span>&nbsp;<span class="element-name">ALL_DATASET</span></div>
 <div class="block">Lookup based on all objects (both valid and deprecated) known to the factory.
  This is the same search than <a href="#VALID_DATASET"><code>VALID_DATASET</code></a> except that deprecated objects
  are included in the search.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="values()">
 <h3>values</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
 <div class="block">Returns an array containing the constants of this enum class, in
 the order they are declared.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>an array containing the constants of this enum class, in the order they are declared</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="valueOf(java.lang.String)">
 <h3>valueOf</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></span>&nbsp;<span class="element-name">valueOf</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>&nbsp;name)</span></div>
 <div class="block">Returns the enum constant of this class with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this class.  (Extraneous whitespace characters are
 not permitted.)</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
 <dt>Returns:</dt>
 <dd>the enum constant with the specified name</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 this enum class has no constant with the specified name</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </div>
 </body>
 </html>