boudjeml/FIProjetIHM2022
1
2
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dd958e5067
FIProjetIHM2022/docs/API/Groupe.html

507 lines
18 KiB
HTML
Raw Normal View History

$
2022-11-15 17:38:45 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
$
2022-11-15 19:46:10 +01:00
<!-- Generated by javadoc (1.8.0_202) on Tue Nov 15 19:45:36 CET 2022 -->
$
2022-11-15 17:38:45 +01:00
<title>Groupe</title>
$
2022-11-15 18:57:04 +01:00
<meta name="date" content="2022-11-15">
$
2022-11-15 17:38:45 +01:00
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Groupe";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":18,"i12":6,"i13":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.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-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../API/Etudiant.html" title="interface in API"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../API/MonPrint.html" title="interface in API"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?API/Groupe.html" target="_top">Frames</a></li>
<li><a href="Groupe.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">API</div>
<h2 title="Interface Groupe" class="title">Interface Groupe</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../API/MonPrint.html" title="interface in API">MonPrint</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../MNP/GroupeNP.html" title="class in MNP">GroupeNP</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Groupe</span>
extends <a href="../API/MonPrint.html" title="interface in API">MonPrint</a></pre>
<div class="block">Un groupe</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#addEtudiant-API.Etudiant-">addEtudiant</a></span>(<a href="../API/Etudiant.html" title="interface in API">Etudiant</a>&nbsp;e)</code>
<div class="block">Ajoute un étudiant.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#addSousGroupe-API.Groupe-">addSousGroupe</a></span>(<a href="../API/Groupe.html" title="interface in API">Groupe</a>&nbsp;g)</code>
<div class="block">Ajoute un sous-groupe.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../API/Etudiant.html" title="interface in API">Etudiant</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getEtudiants--">getEtudiants</a></span>()</code>
<div class="block">Potentiellement "vide"</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getId--">getId</a></span>()</code>
<div class="block">permet de récupérer l'identifiant d'un groupe (référence interne sans intérêt irl).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getMax--">getMax</a></span>()</code>
<div class="block">permet de récupérer le nombre maximum d'étudiants souhaités dans un groupe.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getMin--">getMin</a></span>()</code>
<div class="block">permet de récupérer le nombre minimum d'étudiants souhaités dans le groupe.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getName--">getName</a></span>()</code>
<div class="block">permet de récupérer le nom d'un groupe (utile irl).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../API/Groupe.html" title="interface in API">Groupe</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getPointPoint--">getPointPoint</a></span>()</code>
<div class="block">permet de récupérer le groupe père
un groupe racine devrait retourner lui-même</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getSize--">getSize</a></span>()</code>
<div class="block">permet de récupérer le nombre d'étudiants dans ce groupe.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../API/Groupe.html" title="interface in API">Groupe</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getSousGroupes--">getSousGroupes</a></span>()</code>
<div class="block">Potentiellement "vide"</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../API/TypeGroupe.html" title="enum in API">TypeGroupe</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#getType--">getType</a></span>()</code>
<div class="block">permet de récupérer la nature du groupe</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#monPrint--">monPrint</a></span>()</code>
<div class="block">Fonctionne comme ToPrint() sauf car une interface n'a pas le droit de faire un override sur ToPrint().</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#removeEtudiant-API.Etudiant-">removeEtudiant</a></span>(<a href="../API/Etudiant.html" title="interface in API">Etudiant</a>&nbsp;e)</code>
<div class="block">Enlève un étudiant.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../API/Groupe.html#removeSousGroupe-API.Groupe-">removeSousGroupe</a></span>(<a href="../API/Groupe.html" title="interface in API">Groupe</a>&nbsp;g)</code>
<div class="block">Enlève un groupe.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addEtudiant-API.Etudiant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEtudiant</h4>
<pre>boolean&nbsp;addEtudiant(<a href="../API/Etudiant.html" title="interface in API">Etudiant</a>&nbsp;e)</pre>
<div class="block">Ajoute un étudiant. Se comporte comme add de l'interface Set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff e est ajouté</dd>
</dl>
</li>
</ul>
<a name="removeEtudiant-API.Etudiant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEtudiant</h4>
<pre>boolean&nbsp;removeEtudiant(<a href="../API/Etudiant.html" title="interface in API">Etudiant</a>&nbsp;e)</pre>
<div class="block">Enlève un étudiant. Se comporte comme remove de l'interface Set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff e est enlevé</dd>
</dl>
</li>
</ul>
<a name="addSousGroupe-API.Groupe-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSousGroupe</h4>
<pre>boolean&nbsp;addSousGroupe(<a href="../API/Groupe.html" title="interface in API">Groupe</a>&nbsp;g)</pre>
<div class="block">Ajoute un sous-groupe. Se comporte comme add de l'interface Set.
vérifie que le groupe passé en argument a bien renseigné this comme son père.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff g est ajouté</dd>
</dl>
</li>
</ul>
<a name="removeSousGroupe-API.Groupe-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSousGroupe</h4>
<pre>boolean&nbsp;removeSousGroupe(<a href="../API/Groupe.html" title="interface in API">Groupe</a>&nbsp;g)</pre>
<div class="block">Enlève un groupe. Se comporte comme remove de l'interface Set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff e est enlevé</dd>
</dl>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>int&nbsp;getId()</pre>
<div class="block">permet de récupérer l'identifiant d'un groupe (référence interne sans intérêt irl).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>l'identifiant.</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">permet de récupérer le nom d'un groupe (utile irl).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>le nom.</dd>
</dl>
</li>
</ul>
<a name="getMin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMin</h4>
<pre>int&nbsp;getMin()</pre>
<div class="block">permet de récupérer le nombre minimum d'étudiants souhaités dans le groupe.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>le minimum souhaité</dd>
</dl>
</li>
</ul>
<a name="getMax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMax</h4>
<pre>int&nbsp;getMax()</pre>
<div class="block">permet de récupérer le nombre maximum d'étudiants souhaités dans un groupe.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>le maximum souhaité</dd>
</dl>
</li>
</ul>
<a name="getSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>int&nbsp;getSize()</pre>
<div class="block">permet de récupérer le nombre d'étudiants dans ce groupe.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>le nombre de places prises (pas forcément limité entre Min et Max, mais c'est le but)</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="../API/TypeGroupe.html" title="enum in API">TypeGroupe</a>&nbsp;getType()</pre>
<div class="block">permet de récupérer la nature du groupe</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>le type du groupe</dd>
</dl>
</li>
</ul>
<a name="getPointPoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPointPoint</h4>
<pre><a href="../API/Groupe.html" title="interface in API">Groupe</a>&nbsp;getPointPoint()</pre>
<div class="block">permet de récupérer le groupe père
un groupe racine devrait retourner lui-même</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>le père</dd>
</dl>
</li>
</ul>
<a name="getSousGroupes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSousGroupes</h4>
<pre>java.util.Set&lt;<a href="../API/Groupe.html" title="interface in API">Groupe</a>&gt;&nbsp;getSousGroupes()</pre>
<div class="block">Potentiellement "vide"</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>l'ensemble des sous-groupes.</dd>
</dl>
</li>
</ul>
<a name="getEtudiants--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEtudiants</h4>
<pre>java.util.Set&lt;<a href="../API/Etudiant.html" title="interface in API">Etudiant</a>&gt;&nbsp;getEtudiants()</pre>
<div class="block">Potentiellement "vide"</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>l'ensemble des étudiants.</dd>
</dl>
</li>
</ul>
<a name="monPrint--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>monPrint</h4>
<pre>default&nbsp;java.lang.String&nbsp;monPrint()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../API/MonPrint.html#monPrint--">MonPrint</a></code></span></div>
<div class="block">Fonctionne comme ToPrint() sauf car une interface n'a pas le droit de faire un override sur ToPrint().
Toutes nos interfaces vont étendre cette interface.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../API/MonPrint.html#monPrint--">monPrint</a></code>&nbsp;in interface&nbsp;<code><a href="../API/MonPrint.html" title="interface in API">MonPrint</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../API/MonPrint.html" title="interface in API"><code>NB. On n'utilise le mécanisme des méthodes par défaut pour donner du code dans une interface. C'est un petit peu laid et à contre-emploi mais pratique ici.
<p>
NB2. On ne peut pas utiliser le toString de Objects
https://stackoverflow.com/questions/24016962/java8-why-is-it-forbidden-to-define-a-default-method-for-a-method-from-java-lan</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.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-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../API/Etudiant.html" title="interface in API"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../API/MonPrint.html" title="interface in API"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?API/Groupe.html" target="_top">Frames</a></li>
<li><a href="Groupe.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink