diff options
| author | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 16:09:37 +0100 |
|---|---|---|
| committer | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 16:09:37 +0100 |
| commit | de39259ada4f75ac987f9bd8f0674ebede75a0de (patch) | |
| tree | e9987d753d0183880117bd89135adaf7ac3b135b /javadoc/jMusicHub.html | |
| parent | e28cfe68365eecd5c4f1d9bfd92c225ccd1a4697 (diff) | |
Starting javadoc
Diffstat (limited to 'javadoc/jMusicHub.html')
| -rw-r--r-- | javadoc/jMusicHub.html | 533 |
1 files changed, 533 insertions, 0 deletions
diff --git a/javadoc/jMusicHub.html b/javadoc/jMusicHub.html new file mode 100644 index 0000000..46b3f16 --- /dev/null +++ b/javadoc/jMusicHub.html @@ -0,0 +1,533 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 15:55:07 CET 2020 --> +<title>jMusicHub</title> +<meta name="date" content="2020-12-28"> +<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="jMusicHub"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="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="Genre.html" title="enum in <Unnamed>"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="Language.html" title="enum in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="index.html?jMusicHub.html" target="_top">Frames</a></li> +<li><a href="jMusicHub.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All 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: </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="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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"> +<h2 title="Class jMusicHub" class="title">Class jMusicHub</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>jMusicHub</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">jMusicHub</span> +extends java.lang.Object</pre> +<div class="block">The jMusicHub class is basically the app. + It is used to launch the whole process.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2020-11-13</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="jMusicHub.html#jMusicHub--">jMusicHub</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="Album.html" title="class in <Unnamed>">Album</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#addAlbum-java.util.Scanner-">addAlbum</a></span>(java.util.Scanner scan)</code> +<div class="block">addAlbum is used to add albums thanks to the "a" option</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#addAudioBook-java.util.Scanner-">addAudioBook</a></span>(java.util.Scanner scan)</code> +<div class="block">addAudioBook is used to add songs thanks to the "l" option</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#addPlaylist-java.util.Scanner-java.util.ArrayList-java.util.ArrayList-">addPlaylist</a></span>(java.util.Scanner scan, + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs, + java.util.ArrayList<<a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a>> audiobooks)</code> +<div class="block">addPlaylist is used to add playlist thanks to the "p" option</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="Song.html" title="class in <Unnamed>">Song</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#addSong-java.util.Scanner-">addSong</a></span>(java.util.Scanner scan)</code> +<div class="block">addSong is used to add songs thanks to the "c" option</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#addSongToAlbum-java.util.Scanner-java.util.ArrayList-java.util.ArrayList-">addSongToAlbum</a></span>(java.util.Scanner scan, + java.util.ArrayList<<a href="Album.html" title="class in <Unnamed>">Album</a>> albums, + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#contentOfAlbum-java.util.ArrayList-">contentOfAlbum</a></span>(java.util.ArrayList<<a href="Album.html" title="class in <Unnamed>">Album</a>> albums)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#contentOfPlaylist-java.util.ArrayList-">contentOfPlaylist</a></span>(java.util.ArrayList<<a href="Playlist.html" title="class in <Unnamed>">Playlist</a>> playlists)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static java.util.ArrayList<<a href="Playlist.html" title="class in <Unnamed>">Playlist</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#delPlaylist-java.util.ArrayList-">delPlaylist</a></span>(java.util.ArrayList<<a href="Playlist.html" title="class in <Unnamed>">Playlist</a>> playlists)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static java.util.ArrayList</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#extract-java.lang.String-">extract</a></span>(java.lang.String filename)</code> +<div class="block">Extract is used to print the content of the files and put them in the ArrayList used to add elements.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listAlbumsByDate--">listAlbumsByDate</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listAlbumsByGenre--">listAlbumsByGenre</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listAudioBooksByAuthor--">listAudioBooksByAuthor</a></span>()</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listById-java.lang.String-">listById</a></span>(java.lang.String filename)</code> +<div class="block">list is called when using the "AB", "S", "A" and "P" commands in order to list the elements in respective files.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listPlaylistsByName--">listPlaylistsByName</a></span>()</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#save-java.lang.String-java.util.ArrayList-">save</a></span>(java.lang.String filename, + java.util.ArrayList elements)</code> +<div class="block">save is used by the command "s" + It is used to serialize (save) arrays of a list into the type's file.i + Exemple : save("nameOfTheFile", elements) + It will save the arrayList named elements into nameOfTheFile in the working directory.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="jMusicHub--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>jMusicHub</h4> +<pre>public jMusicHub()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addSong-java.util.Scanner-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSong</h4> +<pre>public static <a href="Song.html" title="class in <Unnamed>">Song</a> addSong(java.util.Scanner scan)</pre> +<div class="block">addSong is used to add songs thanks to the "c" option</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - Scanner Object</dd> +</dl> +</li> +</ul> +<a name="addAudioBook-java.util.Scanner-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAudioBook</h4> +<pre>public static <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a> addAudioBook(java.util.Scanner scan)</pre> +<div class="block">addAudioBook is used to add songs thanks to the "l" option</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - Scanner Object</dd> +</dl> +</li> +</ul> +<a name="addAlbum-java.util.Scanner-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAlbum</h4> +<pre>public static <a href="Album.html" title="class in <Unnamed>">Album</a> addAlbum(java.util.Scanner scan)</pre> +<div class="block">addAlbum is used to add albums thanks to the "a" option</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - Scanner Object</dd> +</dl> +</li> +</ul> +<a name="addPlaylist-java.util.Scanner-java.util.ArrayList-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPlaylist</h4> +<pre>public static <a href="Playlist.html" title="class in <Unnamed>">Playlist</a> addPlaylist(java.util.Scanner scan, + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs, + java.util.ArrayList<<a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a>> audiobooks)</pre> +<div class="block">addPlaylist is used to add playlist thanks to the "p" option</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - Scanner Object</dd> +</dl> +</li> +</ul> +<a name="save-java.lang.String-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>save</h4> +<pre>public static void save(java.lang.String filename, + java.util.ArrayList elements)</pre> +<div class="block">save is used by the command "s" + It is used to serialize (save) arrays of a list into the type's file.i + Exemple : save("nameOfTheFile", elements) + It will save the arrayList named elements into nameOfTheFile in the working directory.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filename</code> - String</dd> +<dd><code>elements</code> - ArrayList</dd> +</dl> +</li> +</ul> +<a name="listById-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listById</h4> +<pre>public static void listById(java.lang.String filename)</pre> +<div class="block">list is called when using the "AB", "S", "A" and "P" commands in order to list the elements in respective files.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filename</code> - String</dd> +</dl> +</li> +</ul> +<a name="listPlaylistsByName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listPlaylistsByName</h4> +<pre>public static void listPlaylistsByName()</pre> +</li> +</ul> +<a name="listAlbumsByDate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listAlbumsByDate</h4> +<pre>public static void listAlbumsByDate()</pre> +</li> +</ul> +<a name="listAlbumsByGenre--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listAlbumsByGenre</h4> +<pre>public static void listAlbumsByGenre()</pre> +</li> +</ul> +<a name="listAudioBooksByAuthor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listAudioBooksByAuthor</h4> +<pre>public static void listAudioBooksByAuthor()</pre> +</li> +</ul> +<a name="extract-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extract</h4> +<pre>public static java.util.ArrayList extract(java.lang.String filename)</pre> +<div class="block">Extract is used to print the content of the files and put them in the ArrayList used to add elements.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filename</code> - String</dd> +</dl> +</li> +</ul> +<a name="addSongToAlbum-java.util.Scanner-java.util.ArrayList-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSongToAlbum</h4> +<pre>public static void addSongToAlbum(java.util.Scanner scan, + java.util.ArrayList<<a href="Album.html" title="class in <Unnamed>">Album</a>> albums, + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs)</pre> +</li> +</ul> +<a name="delPlaylist-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delPlaylist</h4> +<pre>public static java.util.ArrayList<<a href="Playlist.html" title="class in <Unnamed>">Playlist</a>> delPlaylist(java.util.ArrayList<<a href="Playlist.html" title="class in <Unnamed>">Playlist</a>> playlists)</pre> +</li> +</ul> +<a name="contentOfPlaylist-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contentOfPlaylist</h4> +<pre>public static void contentOfPlaylist(java.util.ArrayList<<a href="Playlist.html" title="class in <Unnamed>">Playlist</a>> playlists)</pre> +</li> +</ul> +<a name="contentOfAlbum-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contentOfAlbum</h4> +<pre>public static void contentOfAlbum(java.util.ArrayList<<a href="Album.html" title="class in <Unnamed>">Album</a>> albums)</pre> +</li> +</ul> +<a name="main-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args)</pre> +</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="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="Genre.html" title="enum in <Unnamed>"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="Language.html" title="enum in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="index.html?jMusicHub.html" target="_top">Frames</a></li> +<li><a href="jMusicHub.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All 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: </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="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |