UQAC-POOA-pigeons/doc/pigeons/Food.html

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (15) on Sun Nov 20 21:38:24 EST 2022 -->
<title>Food</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-11-20">
<meta name="description" content="declaration: package: pigeons, class: Food">
<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">
<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.5.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 data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "alt-color";
var rowColor = "row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
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">
<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="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">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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">pigeons</a></div>
<h1 title="Class Food" class="title">Class Food</h1>
</div>
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">pigeons.Food</div>
</div>
<section class="description">
<hr>
<pre>public class <span class="type-name-label">Food</span>
extends java.lang.Object</pre>
<div class="block">Classe permettant de gÃ©rer une nourriture</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.0</dd>
</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="member-summary">
<table class="summary-table">
<caption><span>Fields</span></caption>
<thead>
<tr>
<th class="col-first" scope="col">Modifier and Type</th>
<th class="col-second" scope="col">Field</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color">
<td class="col-first"><code>java.awt.Color</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#color">color</a></span></code></th>
<td class="col-last">
<div class="block">Couleur de la nourriture
 - Rouge si non consommable
 - Jaune si consommable</div>
</td>
</tr>
<tr class="row-color">
<td class="col-first"><code>private long</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#freshTimeLeft">freshTimeLeft</a></span></code></th>
<td class="col-last">
<div class="block">Temps restant de fraicheur de la nourriture</div>
</td>
</tr>
<tr class="alt-color">
<td class="col-first"><code>private boolean</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#isFresh">isFresh</a></span></code></th>
<td class="col-last">
<div class="block">ConsommabilitÃ© de la nourriture</div>
</td>
</tr>
<tr class="row-color">
<td class="col-first"><code>private java.util.concurrent.atomic.AtomicInteger</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#numWriter">numWriter</a></span></code></th>
<td class="col-last">
<div class="block">Nombre de thread travaillant en ecriture sur l'objet</div>
</td>
</tr>
<tr class="alt-color">
<td class="col-first"><code>private <a href="Position.html" title="class in pigeons">Position</a></code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#position">position</a></span></code></th>
<td class="col-last">
<div class="block">Position de la nourriture</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="member-summary">
<table class="summary-table">
<caption><span>Constructors</span></caption>
<thead>
<tr>
<th class="col-first" scope="col">Constructor</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color">
<th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E(int,int)">Food</a></span>&#8203;(int&nbsp;x,
int&nbsp;y)</code></th>
<td class="col-last">
<div class="block">Constructeur de l'objet representant une nourriture</div>
</td>
</tr>
<tr class="row-color">
<th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E(pigeons.Position)">Food</a></span>&#8203;(<a href="Position.html" title="class in pigeons">Position</a>&nbsp;position)</code></th>
<td class="col-last">
<div class="block">Constructeur de l'objet representant une nourriture</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div class="member-summary" id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<table class="summary-table" aria-labelledby="t0">
<thead>
<tr>
<th class="col-first" scope="col">Modifier and Type</th>
<th class="col-second" scope="col">Method</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color" id="i0">
<td class="col-first"><code>java.awt.Color</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getColor()">getColor</a></span>()</code></th>
<td class="col-last">
<div class="block">Obtenir la couleur associÃ© une nourriture</div>
</td>
</tr>
<tr class="row-color" id="i1">
<td class="col-first"><code>long</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getFreshTimeLeft()">getFreshTimeLeft</a></span>()</code></th>
<td class="col-last">
<div class="block">Obtenir le temps de fraicheur restant Ã  une nourriture

 Cette mÃ©thode est executÃ© avec un verrou ce qui permet aux oiseaux de
 recuperer la propriÃ©tÃ© en Ã©tant sur que la variable n'est pas en cours de
 modification</div>
</td>
</tr>
<tr class="alt-color" id="i2">
<td class="col-first"><code><a href="Position.html" title="class in pigeons">Position</a></code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getPosition()">getPosition</a></span>()</code></th>
<td class="col-last">
<div class="block">Obtenir la position de la nourriture</div>
</td>
</tr>
<tr class="row-color" id="i3">
<td class="col-first"><code>boolean</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#isFresh()">isFresh</a></span>()</code></th>
<td class="col-last">
<div class="block">Obtenir la consommabitÃ© de la nourriture

 Cette fonction est executÃ© avec un verrou ce qui permet aux oiseaux de
 recuperer la propriÃ©tÃ© en Ã©tant sur que la variable n'est pas en cours de
 modification</div>
</td>
</tr>
<tr class="alt-color" id="i4">
<td class="col-first"><code>void</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#reduceFreshTimeLeft(long)">reduceFreshTimeLeft</a></span>&#8203;(long&nbsp;toReduce)</code></th>
<td class="col-last">
<div class="block">Reduit le temps de fraicheur de la nourriture.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="position">
<h3>position</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="Position.html" title="class in pigeons">Position</a></span>&nbsp;<span class="member-name">position</span></div>
<div class="block">Position de la nourriture</div>
</section>
</li>
<li>
<section class="detail" id="isFresh">
<h3>isFresh</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="member-name">isFresh</span></div>
<div class="block">ConsommabilitÃ© de la nourriture</div>
</section>
</li>
<li>
<section class="detail" id="freshTimeLeft">
<h3>freshTimeLeft</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="member-name">freshTimeLeft</span></div>
<div class="block">Temps restant de fraicheur de la nourriture</div>
</section>
</li>
<li>
<section class="detail" id="numWriter">
<h3>numWriter</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">java.util.concurrent.atomic.AtomicInteger</span>&nbsp;<span class="member-name">numWriter</span></div>
<div class="block">Nombre de thread travaillant en ecriture sur l'objet</div>
</section>
</li>
<li>
<section class="detail" id="color">
<h3>color</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">java.awt.Color</span>&nbsp;<span class="member-name">color</span></div>
<div class="block">Couleur de la nourriture
 - Rouge si non consommable
 - Jaune si consommable</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(pigeons.Position)">
<h3>Food</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="member-name">Food</span>&#8203;(<span class="parameters"><a href="Position.html" title="class in pigeons">Position</a>&nbsp;position)</span></div>
<div class="block">Constructeur de l'objet representant une nourriture</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>position</code> - Position de la nourriture</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int,int)">
<h3>Food</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="member-name">Food</span>&#8203;(<span class="parameters">int&nbsp;x,
int&nbsp;y)</span></div>
<div class="block">Constructeur de l'objet representant une nourriture</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - position sur l'axe des abscisses de la nourriture</dd>
<dd><code>y</code> - postiion sur l'axe des ordonnÃ©es de la nourriture</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="getPosition()">
<h3>getPosition</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Position.html" title="class in pigeons">Position</a></span>&nbsp;<span class="member-name">getPosition</span>()</div>
<div class="block">Obtenir la position de la nourriture</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>position de la nourriture</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="reduceFreshTimeLeft(long)">
<h3>reduceFreshTimeLeft</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="member-name">reduceFreshTimeLeft</span>&#8203;(<span class="parameters">long&nbsp;toReduce)</span></div>
<div class="block">Reduit le temps de fraicheur de la nourriture.
 Si le temps restants de fraicheur, la nourriture est considerÃ© comme non
 consommable et la variable <a href="#isFresh"><code>isFresh</code></a> vaut desormais
 <code>true</code>. Par ailleurs la couleur d'une nourriture devient rouge</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>toReduce</code> - Temps Ã  retirer du temps restant de fraicheur</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getColor()">
<h3>getColor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">java.awt.Color</span>&nbsp;<span class="member-name">getColor</span>()</div>
<div class="block">Obtenir la couleur associÃ© une nourriture</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>La couleur associÃ© Ã  la nouritture, jaune si consommable, rouge sinon</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFreshTimeLeft()">
<h3>getFreshTimeLeft</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="member-name">getFreshTimeLeft</span>()</div>
<div class="block">Obtenir le temps de fraicheur restant Ã  une nourriture

 Cette mÃ©thode est executÃ© avec un verrou ce qui permet aux oiseaux de
 recuperer la propriÃ©tÃ© en Ã©tant sur que la variable n'est pas en cours de
 modification</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Temps de fraicheur restant Ã  la nourriture</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isFresh()">
<h3>isFresh</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="member-name">isFresh</span>()</div>
<div class="block">Obtenir la consommabitÃ© de la nourriture

 Cette fonction est executÃ© avec un verrou ce qui permet aux oiseaux de
 recuperer la propriÃ©tÃ© en Ã©tant sur que la variable n'est pas en cours de
 modification</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>boolean</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottom-nav" id="navbar.bottom">
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
<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">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<span class="skip-nav" id="skip.navbar.bottom">
<!--   -->
</span></nav>
</footer>
</div>
</div>
</body>
</html>