librejack/docs/controller/Hand.html (18744B)
<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (20) on Sun May 21 12:02:46 SAST 2023 --> <title>Hand (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: controller, class: Hand"> <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/Hand.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>Nested</li> <li>Field</li> <li><a href="#constructor-summary">Constr</a></li> <li><a href="#method-summary">Method</a></li> </ul> </li> <li> <p>Detail:</p> <ul> <li>Field</li> <li><a href="#constructor-detail">Constr</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>Nested | </li> <li>Field | </li> <li><a href="#constructor-summary">Constr</a> | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor-detail">Constr</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">controller</a></div> <h1 title="Class Hand" class="title">Class Hand</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">controller.Hand</div> </div> <section class="class-description" id="class-description"> <hr> <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Hand</span> <span class="extends-implements">extends <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></span></div> <div class="block">Contains methods to calculate the value of a hand, take cards from a deck and discard the hand to a deck.</div> <dl class="notes"> <dt>Author:</dt> <dd>Michael Neuper <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> </dl> </section> <section class="summary"> <ul class="summary-list"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor-summary"> <h2>Constructor Summary</h2> <div class="caption"><span>Constructors</span></div> <div class="summary-table two-column-summary"> <div class="table-header col-first">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Hand</a>()</code></div> <div class="col-last even-row-color"> <div class="block">Constructs a new empty <code>Hand</code> object.</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-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>int</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#calculateValue()" class="member-name-link">calculateValue</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Calculates the value of a <a href="Hand.html" title="class in controller"><code>Hand</code></a>.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#discardHandToDeck(model.Deck)" class="member-name-link">discardHandToDeck</a><wbr>(<a href="../model/Deck.html" title="class in model">Deck</a> discardDeck)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Discards the current <a href="Hand.html" title="class in controller"><code>Hand</code></a> and adds its cards to the specified discard <a href="../model/Deck.html" title="class in model"><code>Deck</code></a>.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../model/Card.html" title="class in model">Card</a></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCard(int)" class="member-name-link">getCard</a><wbr>(int i)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Gets the <a href="../model/Card.html" title="class in model"><code>Card</code></a> at a specific index.</div> </div> <div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCardFilePath(int)" class="member-name-link">getCardFilePath</a><wbr>(int i)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Gets the relative file path of a <a href="../model/Card.html" title="class in model"><code>Card</code></a>.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#takeCardFromDeck(model.Deck)" class="member-name-link">takeCardFromDeck</a><wbr>(<a href="../model/Deck.html" title="class in model">Deck</a> deck)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Adds a <a href="../model/Card.html" title="class in model"><code>Card</code></a> from the <a href="../model/Deck.html" title="class in model"><code>Deck</code></a> to the <a href="Hand.html" title="class in controller"><code>Hand</code></a>.</div> </div> <div class="col-first odd-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 odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Returns a <code>String</code> representation of the current <a href="Hand.html" title="class in controller"><code>Hand</code></a>.</div> </div> </div> </div> </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#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/Object.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/Object.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/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#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/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"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <li> <section class="constructor-details" id="constructor-detail"> <h2>Constructor Details</h2> <ul class="member-list"> <li> <section class="detail" id="<init>()"> <h3>Hand</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Hand</span>()</div> <div class="block">Constructs a new empty <code>Hand</code> object.</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="takeCardFromDeck(model.Deck)"> <h3>takeCardFromDeck</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">takeCardFromDeck</span><wbr><span class="parameters">(<a href="../model/Deck.html" title="class in model">Deck</a> deck)</span></div> <div class="block">Adds a <a href="../model/Card.html" title="class in model"><code>Card</code></a> from the <a href="../model/Deck.html" title="class in model"><code>Deck</code></a> to the <a href="Hand.html" title="class in controller"><code>Hand</code></a>.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>deck</code> - deck to take <a href="../model/Card.html" title="class in model"><code>Card</code></a>from</dd> </dl> </section> </li> <li> <section class="detail" id="calculateValue()"> <h3>calculateValue</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">calculateValue</span>()</div> <div class="block">Calculates the value of a <a href="Hand.html" title="class in controller"><code>Hand</code></a>.</div> <dl class="notes"> <dt>Returns:</dt> <dd>the value of a <a href="Hand.html" title="class in controller"><code>Hand</code></a></dd> </dl> </section> </li> <li> <section class="detail" id="getCard(int)"> <h3>getCard</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../model/Card.html" title="class in model">Card</a></span> <span class="element-name">getCard</span><wbr><span class="parameters">(int i)</span></div> <div class="block">Gets the <a href="../model/Card.html" title="class in model"><code>Card</code></a> at a specific index.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>i</code> - the index of the <a href="../model/Card.html" title="class in model"><code>Card</code></a> or get</dd> <dt>Returns:</dt> <dd>the <a href="../model/Card.html" title="class in model"><code>Card</code></a> at index i</dd> </dl> </section> </li> <li> <section class="detail" id="getCardFilePath(int)"> <h3>getCardFilePath</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">getCardFilePath</span><wbr><span class="parameters">(int i)</span></div> <div class="block">Gets the relative file path of a <a href="../model/Card.html" title="class in model"><code>Card</code></a>.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>i</code> - index of the <a href="../model/Card.html" title="class in model"><code>Card</code></a>in <a href="Hand.html" title="class in controller"><code>Hand</code></a></dd> <dt>Returns:</dt> <dd>file path of a <a href="../model/Card.html" title="class in model"><code>Card</code></a> at a specific index, if the index is out of range, a blank card is returned</dd> </dl> </section> </li> <li> <section class="detail" id="discardHandToDeck(model.Deck)"> <h3>discardHandToDeck</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">discardHandToDeck</span><wbr><span class="parameters">(<a href="../model/Deck.html" title="class in model">Deck</a> discardDeck)</span></div> <div class="block">Discards the current <a href="Hand.html" title="class in controller"><code>Hand</code></a> and adds its cards to the specified discard <a href="../model/Deck.html" title="class in model"><code>Deck</code></a>.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>discardDeck</code> - the deck to which the current <a href="Hand.html" title="class in controller"><code>Hand</code></a>'s <a href="../model/Card.html" title="class in model"><code>Card</code></a> will be added</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 a <code>String</code> representation of the current <a href="Hand.html" title="class in controller"><code>Hand</code></a>.</div> <dl class="notes"> <dt>Overrides:</dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> <dt>Returns:</dt> <dd>a <code>String</code> representation of the current <a href="Hand.html" title="class in controller"><code>Hand</code></a></dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>