ChatApp-AL-NM/Javadoc/chatapp/Model/ListUtilisateurs.html
2021-01-30 13:50:00 +01:00

439 satır
19 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (13-ea) on Sat Jan 30 13:49:20 CET 2021 -->
<title>ListUtilisateurs</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-01-30">
<meta name="description" content="declaration: package: chatapp.Model, class: ListUtilisateurs">
<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.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&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="navListSearch"><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>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">chatapp.Model</a></div>
<h1 title="Class ListUtilisateurs" class="title">Class ListUtilisateurs</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">chatapp.Model.ListUtilisateurs</div>
</div>
<section class="description">
<hr>
<pre>public class <span class="typeNameLabel">ListUtilisateurs</span>
extends java.lang.Object</pre>
<div class="block"><p>
Classe représentant la liste des utilisateurs actifs, stockée localement.
</p></div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ListUtilisateurs</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructeur : initialise la liste 'actifUsers'</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addList(chatapp.Model.Utilisateur)">addList</a></span>&#8203;(<a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&nbsp;u)</code></th>
<td class="colLast">
<div class="block">Ajouter des utilisateurs actifs dans l'attribut liste 'actifUsers'</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afficherListeUtilisateurs()">afficherListeUtilisateurs</a></span>()</code></th>
<td class="colLast">
<div class="block">Méthode affichant la liste des utilisateurs actifs</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appartient(chatapp.Model.Utilisateur)">appartient</a></span>&#8203;(<a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&nbsp;u)</code></th>
<td class="colLast">
<div class="block">Méthode permettant de savoir si un utilisateur est contenu dans la liste 'actifUsers'</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>java.util.ArrayList&lt;<a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActifUsers()">getActifUsers</a></span>()</code></th>
<td class="colLast">
<div class="block">Getter : ActifUsers (liste des utilisateurs actifs)</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIDList(java.lang.String)">getIDList</a></span>&#8203;(java.lang.String&nbsp;iD)</code></th>
<td class="colLast">
<div class="block">Récupérer un utilisateur à partir de son ID</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIPList(java.net.InetAddress)">getIPList</a></span>&#8203;(java.net.InetAddress&nbsp;ip)</code></th>
<td class="colLast">
<div class="block">Récupérer un utilisateur à partir de son addresse IP</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPseudoList(java.lang.String)">getPseudoList</a></span>&#8203;(java.lang.String&nbsp;pseudo)</code></th>
<td class="colLast">
<div class="block">Récupérer un utilisateur à partir de son pseudo.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#modifierList(java.lang.String,java.lang.String)">modifierList</a></span>&#8203;(java.lang.String&nbsp;ancien,
java.lang.String&nbsp;nouveau)</code></th>
<td class="colLast">
<div class="block">Modifier le pseudo d'un utilisateur dans la liste des utilisateurs actifs 'actifUsers'</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supprimerList(chatapp.Model.Utilisateur)">supprimerList</a></span>&#8203;(<a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&nbsp;u)</code></th>
<td class="colLast">
<div class="block">Supprimer de la liste des utilisateurs actifs 'actifUsers' un certain utilisateur</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verifierUnicite(java.lang.String)">verifierUnicite</a></span>&#8203;(java.lang.String&nbsp;pseudo)</code></th>
<td class="colLast">
<div class="block">Vérifie qu'aucun autre utilisateur ne posséde le meme pseudo</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">ListUtilisateurs</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">ListUtilisateurs</span>()</div>
<div class="block">Constructeur : initialise la liste 'actifUsers'</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="addList(chatapp.Model.Utilisateur)">addList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">addList</span>&#8203;(<span class="arguments"><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&nbsp;u)</span></div>
<div class="block">Ajouter des utilisateurs actifs dans l'attribut liste 'actifUsers'</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>u</code> - On va rajouter cet utilisateur dans la liste</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPseudoList(java.lang.String)">getPseudoList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a></span>&nbsp;<span class="memberName">getPseudoList</span>&#8203;(<span class="arguments">java.lang.String&nbsp;pseudo)</span></div>
<div class="block">Récupérer un utilisateur à partir de son pseudo.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pseudo</code> - Pseudo de l'utilisateur que l'on souhaite retrouver</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>L'utilisateur associé à ce pseudo</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getIPList(java.net.InetAddress)">getIPList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a></span>&nbsp;<span class="memberName">getIPList</span>&#8203;(<span class="arguments">java.net.InetAddress&nbsp;ip)</span>
throws <span class="exceptions">java.lang.Exception</span></div>
<div class="block">Récupérer un utilisateur à partir de son addresse IP</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ip</code> - Adresse IP de l'utilisateur que l'on souhaite retrouver</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>L'utilisateur associé à l'adresse IP</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - No such user with this IP address</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getIDList(java.lang.String)">getIDList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a></span>&nbsp;<span class="memberName">getIDList</span>&#8203;(<span class="arguments">java.lang.String&nbsp;iD)</span>
throws <span class="exceptions">java.lang.Exception</span></div>
<div class="block">Récupérer un utilisateur à partir de son ID</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>iD</code> - L'ID de l'utilisateur que l'on souhaite retrouver</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>L'utilisateur associé à l'adresse ID</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - No such user with this ID</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="supprimerList(chatapp.Model.Utilisateur)">supprimerList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">supprimerList</span>&#8203;(<span class="arguments"><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&nbsp;u)</span></div>
<div class="block">Supprimer de la liste des utilisateurs actifs 'actifUsers' un certain utilisateur</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>u</code> - On va supprimer cet utilisateur dans la liste</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="modifierList(java.lang.String,java.lang.String)">modifierList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">modifierList</span>&#8203;(<span class="arguments">java.lang.String&nbsp;ancien,
java.lang.String&nbsp;nouveau)</span></div>
<div class="block">Modifier le pseudo d'un utilisateur dans la liste des utilisateurs actifs 'actifUsers'</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ancien</code> - Pseudo à remplacer</dd>
<dd><code>nouveau</code> - Nouveau pseudo</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="appartient(chatapp.Model.Utilisateur)">appartient</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.lang.Boolean</span>&nbsp;<span class="memberName">appartient</span>&#8203;(<span class="arguments"><a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&nbsp;u)</span></div>
<div class="block">Méthode permettant de savoir si un utilisateur est contenu dans la liste 'actifUsers'</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>u</code> - On souhaite savoir si cet utilisateur appartient a la liste</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True si il appartient, False sinon</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="verifierUnicite(java.lang.String)">verifierUnicite</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.lang.Boolean</span>&nbsp;<span class="memberName">verifierUnicite</span>&#8203;(<span class="arguments">java.lang.String&nbsp;pseudo)</span></div>
<div class="block">Vérifie qu'aucun autre utilisateur ne posséde le meme pseudo</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pseudo</code> - Pseudo dont on veut vérifier l'unicité</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True si aucun utilisateur de la liste possède ce pseudo, False sinon</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="afficherListeUtilisateurs()">afficherListeUtilisateurs</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">afficherListeUtilisateurs</span>()</div>
<div class="block">Méthode affichant la liste des utilisateurs actifs</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getActifUsers()">getActifUsers</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.util.ArrayList&lt;<a href="Utilisateur.html" title="class in chatapp.Model">Utilisateur</a>&gt;</span>&nbsp;<span class="memberName">getActifUsers</span>()</div>
<div class="block">Getter : ActifUsers (liste des utilisateurs actifs)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>La liste des utilisateurs actifs</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>