blob: 37b6aea0f90c67c9bd2eb63aeffd1e548fc2ec27 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>ParameterFormat.ContentLevel (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.parameter, class: ParameterFormat, enum: ContentLevel">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.parameter.ParameterFormat.ContentLevel 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.parameter</a></div>
<h1 title="Enum Class ParameterFormat.ContentLevel" class="title">Enum Class ParameterFormat.ContentLevel</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</a>&gt;
<div class="inheritance">ContentLevel</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">Parameter­Format​.Content­Level</a>&gt;</code>, <code>Constable</code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><code><a href="ParameterFormat.html" title="class in org.apache.sis.parameter">Parameter­Format</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">ParameterFormat.ContentLevel</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</a>&gt;</span></div>
<div class="block">The amount of information to include in the table formatted by <a href="ParameterFormat.html" title="class in org.apache.sis.parameter"><code>Parameter­Format</code></a>.
The content level controls whether the formatter should write all names and aliases
(at the cost of multi-line rows), or to pickup one name per parameter for a more compact table.
<p>The enumeration value javadoc provide examples of formatting output.</p></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.4</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​.Enum­Desc</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="#BRIEF" class="member-name-link">BRIEF</a></code></div>
<div class="col-last even-row-color">
<div class="block">A medium level of content which formats each parameter on a single line.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#DETAILED" class="member-name-link">DETAILED</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The most detailed content, which includes
<a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> and
<a href="../referencing/AbstractIdentifiedObject.html#getAlias()">aliases</a>.</div>
</div>
<div class="col-first even-row-color"><code><a href="#NAME_SUMMARY" class="member-name-link">NAME_SUMMARY</a></code></div>
<div class="col-last even-row-color">
<div class="block">Limits the content to names and aliases in a tabular format.</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">Parameter­Format​.Content­Level</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">value­Of</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">Parameter­Format​.Content­Level</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">compare­To</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">describe­Constable</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">get­Declaring­Class</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">hash­Code</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">to­String</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">value­Of</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">get­Class</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">notify­All</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="DETAILED">
<h3>DETAILED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</a></span>&nbsp;<span class="element-name">DETAILED</span></div>
<div class="block">The most detailed content, which includes
<a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> and
<a href="../referencing/AbstractIdentifiedObject.html#getAlias()">aliases</a>.
Each parameter may be formatted on many lines if they have aliases.
<h4 id="example-heading">Example</h4>
The <cite>Mercator (variant A)</cite> example given in <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter"><code>Default­Parameter­Descriptor­Group</code></a> javadoc,
(augmented with parameter aliases) formatted at this level produces a text like below:
<pre class="text">
EPSG: Mercator (variant A) (9804)
EPSG: Mercator (1SP)
OGC: Mercator_1SP
╔══════════════════════════════════════╤════════╤════════════╤═══════════════╤═══════════════╗
║ Name │ Type │ Obligation │ Value domain │ Default value ║
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
║ EPSG: Latitude of natural origin │ Double │ Mandatory │ [-80 … 84]° │ 0.0° ║
║ OGC: latitude_of_origin │ │ │ │ ║
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
║ EPSG: Longitude of natural origin │ Double │ Mandatory │ [-180 … 180]° │ 0.0° ║
║ OGC: central_meridian │ │ │ │ ║
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
║ EPSG: Scale factor at natural origin │ Double │ Mandatory │ (0 … ∞) │ 1.0 ║
║ OGC: scale_factor │ │ │ │ ║
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
║ EPSG: False easting │ Double │ Mandatory │ (−∞ … ∞) m │ 0.0 m ║
║ OGC: false_easting │ │ │ │ ║
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
║ EPSG: False northing │ Double │ Mandatory │ (−∞ … ∞) m │ 0.0 m ║
║ OGC: false_northing │ │ │ │ ║
╚══════════════════════════════════════╧════════╧════════════╧═══════════════╧═══════════════╝</pre></div>
</section>
</li>
<li>
<section class="detail" id="BRIEF">
<h3>BRIEF</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</a></span>&nbsp;<span class="element-name">BRIEF</span></div>
<div class="block">A medium level of content which formats each parameter on a single line. For each parameter only the
<a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> is formatted —
<a href="../referencing/AbstractIdentifiedObject.html#getAlias()">aliases</a> and
<a href="../referencing/AbstractIdentifiedObject.html#getIdentifiers()">identifiers</a> are omitted.
<h4 id="example-heading1">Example</h4>
The <cite>Mercator (variant A)</cite> example given in <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter"><code>Default­Parameter­Descriptor­Group</code></a> javadoc
formatted at this level produces a text like below:
<pre class="text">
EPSG: Mercator (variant A)
┌────────────────────────────────┬────────┬────────────┬───────────────┬───────────────┐
│ Name (EPSG) │ Type │ Obligation │ Value domain │ Default value │
├────────────────────────────────┼────────┼────────────┼───────────────┼───────────────┤
│ Latitude of natural origin │ Double │ Mandatory │ [-80 … 84]° │ 0.0° │
│ Longitude of natural origin │ Double │ Mandatory │ [-180 … 180]° │ 0.0° │
│ Scale factor at natural origin │ Double │ Mandatory │ (0 … ∞) │ 1.0 │
│ False easting │ Double │ Mandatory │ (−∞ … ∞) m │ 0.0 m │
│ False northing │ Double │ Mandatory │ (−∞ … ∞) m │ 0.0 m │
└────────────────────────────────┴────────┴────────────┴───────────────┴───────────────┘</pre></div>
</section>
</li>
<li>
<section class="detail" id="NAME_SUMMARY">
<h3>NAME_SUMMARY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</a></span>&nbsp;<span class="element-name">NAME_SUMMARY</span></div>
<div class="block">Limits the content to names and aliases in a tabular format. In addition to parameters,
this level can also format array of operation method, coordinate reference system, <i>etc.</i>
The summary contains the identifier names and aliases aligned in a table.
<h4 id="example-heading2">Example</h4>
The <cite>Mercator (variant A)</cite> example given in <a href="ParameterBuilder.html" title="class in org.apache.sis.parameter"><code>Parameter­Builder</code></a> javadoc
formatted at this level produces a text like below:
<pre class="text">
EPSG: Mercator (variant A)
┌────────────────────────────────┬────────────────────┐
│ EPSG │ OGC │
├────────────────────────────────┼────────────────────┤
│ Latitude of natural origin │ latitude_of_origin │
│ Longitude of natural origin │ central_meridian │
│ Scale factor at natural origin │ scale_factor │
│ False easting │ false_easting │
│ False northing │ false_northing │
└────────────────────────────────┴────────────────────┘</pre>
<h4 id="tip-heading">Tip</h4>
The table formatted by default may be quite large.
It is recommended to invoke <a href="ParameterFormat.html#setPreferredCodespaces(java.lang.String...)"><code>Parameter­Format​.set­Preferred­Codespaces(String[])</code></a>
before to format in order to reduce the amount of columns to display.</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</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="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</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">Illegal­Argument­Exception</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">Null­Pointer­Exception</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>