librejack/docs/model/Card.Rank.html (24803B)
<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (20) on Sun May 21 12:02:46 SAST 2023 --> <title>Card.Rank (librejack)</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-05-21"> <meta name="description" content="declaration: package: model, class: Card, enum: Rank"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../stylesheet.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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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/Card.Rank.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-files/index-1.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><a href="#field-summary">Field</a></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><a href="#field-detail">Field</a></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: </li> <li><a href="#nested-class-summary">Nested</a> | </li> <li><a href="#enum-constant-summary">Enum Constants</a> | </li> <li><a href="#field-summary">Field</a> | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li><a href="#enum-constant-detail">Enum Constants</a> | </li> <li><a href="#field-detail">Field</a> | </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> <a href="package-summary.html">model</a></div> <h1 title="Enum Card.Rank" class="title">Enum Card.Rank</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="Card.Rank.html" title="enum in model">Card.Rank</a>> <div class="inheritance">model.Card.Rank</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/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Card.Rank.html" title="enum in model">Card.Rank</a>></code>, <code>java.lang.constant.Constable</code></dd> </dl> <dl class="notes"> <dt>Enclosing class:</dt> <dd><code><a href="Card.html" title="class in model">Card</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">Card.Rank</span> <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Card.Rank.html" title="enum in model">Card.Rank</a>></span></div> <div class="block">Represents the thirteen possible ranks in a standard playing card deck. Each rank has a name and a value.</div> </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 java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></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="#ACE" class="member-name-link">ACE</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code><a href="#EIGHT" class="member-name-link">EIGHT</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code><a href="#FIVE" class="member-name-link">FIVE</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code><a href="#FOUR" class="member-name-link">FOUR</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code><a href="#JACK" class="member-name-link">JACK</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code><a href="#KING" class="member-name-link">KING</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code><a href="#NINE" class="member-name-link">NINE</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code><a href="#QUEEN" class="member-name-link">QUEEN</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code><a href="#SEVEN" class="member-name-link">SEVEN</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code><a href="#SIX" class="member-name-link">SIX</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code><a href="#TEN" class="member-name-link">TEN</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code><a href="#THREE" class="member-name-link">THREE</a></code></div> <div class="col-last odd-row-color"> </div> <div class="col-first even-row-color"><code><a href="#TWO" class="member-name-link">TWO</a></code></div> <div class="col-last even-row-color"> </div> </div> </section> </li> <!-- =========== 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>final int</code></div> <div class="col-second even-row-color"><code><a href="#RANK_VALUE" class="member-name-link">RANK_VALUE</a></code></div> <div class="col-last even-row-color"> </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/javase/8/docs/api/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 the <a href="Card.Rank.html" title="enum in model"><code>Card.Rank</code></a> as a string.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Card.Rank.html" title="enum in model">Card.Rank</a></code></div> <div class="col-second odd-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/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</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 enum constant of this type with the specified name.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Card.Rank.html" title="enum in model">Card.Rank</a>[]</code></div> <div class="col-second even-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 even-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 type, in the order they are declared.</div> </div> </div> </div> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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/javase/8/docs/api/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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="TWO"> <h3>TWO</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">TWO</span></div> </section> </li> <li> <section class="detail" id="THREE"> <h3>THREE</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">THREE</span></div> </section> </li> <li> <section class="detail" id="FOUR"> <h3>FOUR</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">FOUR</span></div> </section> </li> <li> <section class="detail" id="FIVE"> <h3>FIVE</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">FIVE</span></div> </section> </li> <li> <section class="detail" id="SIX"> <h3>SIX</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">SIX</span></div> </section> </li> <li> <section class="detail" id="SEVEN"> <h3>SEVEN</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">SEVEN</span></div> </section> </li> <li> <section class="detail" id="EIGHT"> <h3>EIGHT</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">EIGHT</span></div> </section> </li> <li> <section class="detail" id="NINE"> <h3>NINE</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">NINE</span></div> </section> </li> <li> <section class="detail" id="TEN"> <h3>TEN</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">TEN</span></div> </section> </li> <li> <section class="detail" id="JACK"> <h3>JACK</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">JACK</span></div> </section> </li> <li> <section class="detail" id="QUEEN"> <h3>QUEEN</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">QUEEN</span></div> </section> </li> <li> <section class="detail" id="KING"> <h3>KING</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">KING</span></div> </section> </li> <li> <section class="detail" id="ACE"> <h3>ACE</h3> <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">ACE</span></div> </section> </li> </ul> </section> </li> <!-- ============ FIELD DETAIL =========== --> <li> <section class="field-details" id="field-detail"> <h2>Field Details</h2> <ul class="member-list"> <li> <section class="detail" id="RANK_VALUE"> <h3>RANK_VALUE</h3> <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">RANK_VALUE</span></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> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a>[]</span> <span class="element-name">values</span>()</div> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared.</div> <dl class="notes"> <dt>Returns:</dt> <dd>an array containing the constants of this enum type, 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> <span class="return-type"><a href="Card.Rank.html" title="enum in model">Card.Rank</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (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/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/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> <li> <section class="detail" id="toString()"> <h3>toString</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> <div class="block">Returns the name of the <a href="Card.Rank.html" title="enum in model"><code>Card.Rank</code></a> as a string.</div> <dl class="notes"> <dt>Overrides:</dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Card.Rank.html" title="enum in model">Card.Rank</a>></code></dd> <dt>Returns:</dt> <dd>the name of the <a href="Card.Rank.html" title="enum in model"><code>Card.Rank</code></a></dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>