org/apache/sis/image/TransferType.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>TransferType (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.image, class: TransferType">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.image.TransferType class">
 <meta name="keywords" content="INT">
 <meta name="keywords" content="FLOAT">
 <meta name="keywords" content="DOUBLE">
 <meta name="keywords" content="valueOf()">
 <meta name="keywords" content="toString()">
 <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/TransferType.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><a href="#field-summary">Field</a></li>
 <li>Constr</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li><a href="#field-detail">Field</a></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><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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.image</a></div>
 <h1 title="Class TransferType" class="title">Class TransferType&lt;T extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/Buffer.html" title="class or interface in java.nio" class="external-link">Buffer</a>&gt;</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">TransferType&lt;T&gt;</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>T</code> - the type of buffer which can be used for transferring data.</dd>
 </dl>
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">TransferType&lt;T extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/Buffer.html" title="class or interface in java.nio" class="external-link">Buffer</a>&gt;</span>
 <span class="extends-implements">extends <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>
 implements <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
 <div class="block">The type of data used to transfer pixels. Data transfers happen in various <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link"><code>Raster</code></a> methods and in
  <a href="PixelIterator.html#createWindow(org.apache.sis.image.TransferType)"><code>PixelIterator.createWindow(TransferType)</code></a>. The type used for transferring data is not necessarily
  the same than the type used by the raster for storing data. In particular, <code>byte</code> and <code>short</code>
  (both signed and unsigned) are converted to <code>int</code> during the transfer.

  <p><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link"><code>Raster</code></a> and <a href="PixelIterator.html" title="class in org.apache.sis.image"><code>PixelIterator</code></a> transfer data in <code>int[]</code>, <code>float[]</code> and <code>double[]</code> arrays.
  Additionally, <code>PixelIterator</code> uses also <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/IntBuffer.html" title="class or interface in java.nio" class="external-link"><code>IntBuffer</code></a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/FloatBuffer.html" title="class or interface in java.nio" class="external-link"><code>FloatBuffer</code></a> and <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/DoubleBuffer.html" title="class or interface in java.nio" class="external-link"><code>DoubleBuffer</code></a>.</p>

  <div class="note"><b>Future evolution:</b>
  this class may be refactored as an enumeration in a future Java version if
  <a href="http://openjdk.java.net/jeps/301">JEP 301</a> is implemented.</div></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.0</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html#getTransferType()" title="class or interface in java.awt.image" class="external-link"><code>Raster.getTransferType()</code></a></li>
 <li><a href="PixelIterator.html#createWindow(org.apache.sis.image.TransferType)"><code>PixelIterator.createWindow(TransferType)</code></a></li>
 <li><a href="../../../../serialized-form.html#org.apache.sis.image.TransferType">Serialized Form</a></li>
 </ul>
 </dd>

 <p><font size="-1">Defined in the <code>sis-feature</code> module</font></p>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final <a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/DoubleBuffer.html" title="class or interface in java.nio" class="external-link">DoubleBuffer</a>&gt;</code></div>
 <div class="col-second even-row-color"><code><a href="#DOUBLE" class="member-name-link">DOUBLE</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Specifies that sample values are transferred as double-precision floating point number.</div>
 </div>
 <div class="col-first odd-row-color"><code>static final <a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/FloatBuffer.html" title="class or interface in java.nio" class="external-link">FloatBuffer</a>&gt;</code></div>
 <div class="col-second odd-row-color"><code><a href="#FLOAT" class="member-name-link">FLOAT</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Specifies that sample values are transferred as single-precision floating point number.</div>
 </div>
 <div class="col-first even-row-color"><code>static final <a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/IntBuffer.html" title="class or interface in java.nio" class="external-link">IntBuffer</a>&gt;</code></div>
 <div class="col-second even-row-color"><code><a href="#INT" class="member-name-link">INT</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Specifies that sample values are transferred as 32 bits signed integer.</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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance 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-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the name of this enumeration constant.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;?&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(int)" class="member-name-link">valueOf</a><wbr>(int&nbsp;type)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the enumeration value for the given <code>DataBuffer</code> constant.</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#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">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="INT">
 <h3>INT</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/IntBuffer.html" title="class or interface in java.nio" class="external-link">IntBuffer</a>&gt;</span>&nbsp;<span class="element-name">INT</span></div>
 <div class="block">Specifies that sample values are transferred as 32 bits signed integer.
  If the raster stores sample values as <code>byte</code> or <code>short</code>, the values are casted by a widening
  conversion before to be transferred. If the raster stores sample values as <code>float</code> or <code>double</code>,
  the values are rounded toward 0 before to be transferred.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="PixelIterator.html#getSample(int)"><code>PixelIterator.getSample(int)</code></a></li>
 <li><a href="PixelIterator.html#getPixel(int%5B%5D)"><code>PixelIterator.getPixel(int[])</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="FLOAT">
 <h3>FLOAT</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/FloatBuffer.html" title="class or interface in java.nio" class="external-link">FloatBuffer</a>&gt;</span>&nbsp;<span class="element-name">FLOAT</span></div>
 <div class="block">Specifies that sample values are transferred as single-precision floating point number.
  Values of other types are casted as needed.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="PixelIterator.html#getSampleFloat(int)"><code>PixelIterator.getSampleFloat(int)</code></a></li>
 <li><a href="PixelIterator.html#getPixel(float%5B%5D)"><code>PixelIterator.getPixel(float[])</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="DOUBLE">
 <h3>DOUBLE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/DoubleBuffer.html" title="class or interface in java.nio" class="external-link">DoubleBuffer</a>&gt;</span>&nbsp;<span class="element-name">DOUBLE</span></div>
 <div class="block">Specifies that sample values are transferred as double-precision floating point number.
  Values of other types are casted as needed. This is the safest transfer type to use
  when wanting to avoid any precision lost.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="PixelIterator.html#getSampleDouble(int)"><code>PixelIterator.getSampleDouble(int)</code></a></li>
 <li><a href="PixelIterator.html#getPixel(double%5B%5D)"><code>PixelIterator.getPixel(double[])</code></a></li>
 </ul>
 </dd>
 </dl>
 </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="valueOf(int)">
 <h3>valueOf</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a>&lt;?&gt;</span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(int&nbsp;type)</span></div>
 <div class="block">Returns the enumeration value for the given <code>DataBuffer</code> constant.
  This method applies the following mapping:

  <ul>
    <li>If <code>type</code> is <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_DOUBLE" title="class or interface in java.awt.image" class="external-link"><code>DataBuffer.TYPE_DOUBLE</code></a>, returns <a href="#DOUBLE"><code>DOUBLE</code></a>.</li>
    <li>If <code>type</code> is <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_FLOAT" title="class or interface in java.awt.image" class="external-link"><code>DataBuffer.TYPE_FLOAT</code></a>, returns <a href="#FLOAT"><code>FLOAT</code></a>.</li>
    <li>If <code>type</code> is <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_INT" title="class or interface in java.awt.image" class="external-link"><code>DataBuffer.TYPE_INT</code></a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_SHORT" title="class or interface in java.awt.image" class="external-link"><code>TYPE_SHORT</code></a>,
           <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_USHORT" title="class or interface in java.awt.image" class="external-link"><code>TYPE_USHORT</code></a> or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_BYTE" title="class or interface in java.awt.image" class="external-link"><code>TYPE_BYTE</code></a>,
           returns <a href="#INT"><code>INT</code></a>.</li>
    <li>If <code>type</code> is <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html#TYPE_UNDEFINED" title="class or interface in java.awt.image" class="external-link"><code>DataBuffer.TYPE_UNDEFINED</code></a> or any other value,
        throws <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a>.</li>
  </ul>

  The <code>type</code> argument given to this method is typically the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html#getTransferType()" title="class or interface in java.awt.image" class="external-link"><code>Raster.getTransferType()</code></a> value.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>type</code> - one of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/DataBuffer.html" title="class or interface in java.awt.image" class="external-link"><code>DataBuffer</code></a> constant.</dd>
 <dt>Returns:</dt>
 <dd>the enumeration value for the given constant.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if (@code type} is not a supported <code>DataBuffer</code> constant.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</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">toString</span>()</div>
 <div class="block">Returns the name of this enumeration constant.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
 <dt>Returns:</dt>
 <dd>the enumeration constant name.</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>