diff options
| author | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 17:31:33 +0100 |
|---|---|---|
| committer | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 17:31:33 +0100 |
| commit | 7c23f453d166d396451504e26fbb385afc0c4c13 (patch) | |
| tree | 01aee8bfcd409dbaa3e90889295869903a4ab5d5 /javadoc/jMusicHub.html | |
| parent | de39259ada4f75ac987f9bd8f0674ebede75a0de (diff) | |
Finishing javadoc
Diffstat (limited to 'javadoc/jMusicHub.html')
| -rw-r--r-- | javadoc/jMusicHub.html | 162 |
1 files changed, 129 insertions, 33 deletions
diff --git a/javadoc/jMusicHub.html b/javadoc/jMusicHub.html index 46b3f16..cfd3b2d 100644 --- a/javadoc/jMusicHub.html +++ b/javadoc/jMusicHub.html @@ -2,7 +2,7 @@ <!-- NewPage --> <html lang="fr"> <head> -<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 15:55:07 CET 2020 --> +<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 17:30:46 CET 2020 --> <title>jMusicHub</title> <meta name="date" content="2020-12-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> @@ -108,8 +108,8 @@ var activeTableTab = "activeTableTab"; <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> +<div class="block">The jMusicHub class is our main component. + It's basically the app we use to launch the whole process.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2020-11-13</dd> @@ -132,7 +132,9 @@ extends java.lang.Object</pre> <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> +<td class="colOne"><code><span class="memberNameLink"><a href="jMusicHub.html#jMusicHub--">jMusicHub</a></span>()</code> +<div class="block">Constructor method, it is calling every methods and contains the command prompt.</div> +</td> </tr> </table> </li> @@ -152,13 +154,13 @@ extends java.lang.Object</pre> <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> +<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> +<div class="block">addAudioBook is used to add songs thanks to the "l" option.</div> </td> </tr> <tr id="i2" class="altColor"> @@ -166,32 +168,40 @@ extends java.lang.Object</pre> <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> +<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> +<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> + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs)</code> +<div class="block">addSongToAlbum is called by the "+" command in order to add a song to an album.</div> +</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> +<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> +<div class="block">contentOfAlbum is called by the "AC" command in order to display the content of a chosen album.</div> +</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> +<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> +<div class="block">contentOfPlaylist is called by the "PC" command in order to display the content of a chosen playlist.</div> +</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> +<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> +<div class="block">delPlaylist is called by the "-" command in order to delete a playlist.</div> +</td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>static java.util.ArrayList</code></td> @@ -201,15 +211,21 @@ extends java.lang.Object</pre> </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> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listAlbumsByDate--">listAlbumsByDate</a></span>()</code> +<div class="block">listAlbumsByDate is called by the "AD" command in order to list the albums sorted by the date of release.</div> +</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> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listAlbumsByGenre--">listAlbumsByGenre</a></span>()</code> +<div class="block">listAlbumsByGenre is called by the "AG" command in order to list the albums sorted by the genre of their songs.</div> +</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> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listAudioBooksByAuthor--">listAudioBooksByAuthor</a></span>()</code> +<div class="block">listAudioBooksByAuthor is called by the "BA" command in order to list the audiobooks sorted by authors.</div> +</td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>static void</code></td> @@ -219,20 +235,21 @@ extends java.lang.Object</pre> </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> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#listPlaylistsByName--">listPlaylistsByName</a></span>()</code> +<div class="block">listPlaylistsByName is called when using the "PN" command in order to list the playlists sorted by their name.</div> +</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> +<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> +<div class="block">The main method is used to launch the app.</div> +</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> +<div class="block">save is used by the command "s".</div> </td> </tr> </table> @@ -264,6 +281,17 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>jMusicHub</h4> <pre>public jMusicHub()</pre> +<div class="block">Constructor method, it is calling every methods and contains the command prompt.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Song.html" title="class in <Unnamed>"><code>Song</code></a>, +<a href="AudioBook.html" title="class in <Unnamed>"><code>AudioBook</code></a>, +<a href="Album.html" title="class in <Unnamed>"><code>Album</code></a>, +<a href="Playlist.html" title="class in <Unnamed>"><code>Playlist</code></a>, +<a href="Genre.html" title="enum in <Unnamed>"><code>Genre</code></a>, +<a href="Category.html" title="enum in <Unnamed>"><code>Category</code></a>, +<a href="Language.html" title="enum in <Unnamed>"><code>Language</code></a></dd> +</dl> </li> </ul> </li> @@ -281,10 +309,16 @@ extends java.lang.Object</pre> <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> +<div class="block">addSong is used to add songs thanks to the "c" option. + It prompts to the user a series of interrogations, asks to confirm. + A new song is then created and returned.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scan</code> - Scanner Object</dd> +<dd><code>scan</code> - Scanner</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>newSong Song</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Song.html" title="class in <Unnamed>"><code>Song</code></a></dd> </dl> </li> </ul> @@ -295,10 +329,16 @@ extends java.lang.Object</pre> <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> +<div class="block">addAudioBook is used to add songs thanks to the "l" option. + It prompts to the user a series of interrogations, asks to confirm. + A new audiobook is then created and returned.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scan</code> - Scanner Object</dd> +<dd><code>scan</code> - Scanner</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>newAudioBook AudioBook</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="AudioBook.html" title="class in <Unnamed>"><code>AudioBook</code></a></dd> </dl> </li> </ul> @@ -309,10 +349,16 @@ extends java.lang.Object</pre> <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> +<div class="block">addAlbum is used to add albums thanks to the "a" option. + It prompts to the user a series of interrogations, asks to confirm. + A new album is then created and returned.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scan</code> - Scanner Object</dd> +<dd><code>scan</code> - Scanner</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>newAlbum Album</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Album.html" title="class in <Unnamed>"><code>Album</code></a></dd> </dl> </li> </ul> @@ -325,10 +371,18 @@ extends java.lang.Object</pre> <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> +<div class="block">addPlaylist is used to add playlist thanks to the "p" option. + It prompts to the user a series of interrogations, asks to confirm. + A new playlist is then created and returned.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scan</code> - Scanner Object</dd> +<dd><code>scan</code> - Scanner</dd> +<dd><code>songs</code> - ArrayList</dd> +<dd><code>audiobooks</code> - ArrayList</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>newPlaylist Playlist</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Playlist.html" title="class in <Unnamed>"><code>Playlist</code></a></dd> </dl> </li> </ul> @@ -340,10 +394,8 @@ extends java.lang.Object</pre> <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> +<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.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>filename</code> - String</dd> @@ -372,6 +424,12 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>listPlaylistsByName</h4> <pre>public static void listPlaylistsByName()</pre> +<div class="block">listPlaylistsByName is called when using the "PN" command in order to list the playlists sorted by their name. + To achieve that, I had to put names in uppercase with getName from Playlist.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Playlist.html#getName--"><code>Playlist.getName()</code></a></dd> +</dl> </li> </ul> <a name="listAlbumsByDate--"> @@ -381,6 +439,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>listAlbumsByDate</h4> <pre>public static void listAlbumsByDate()</pre> +<div class="block">listAlbumsByDate is called by the "AD" command in order to list the albums sorted by the date of release.</div> </li> </ul> <a name="listAlbumsByGenre--"> @@ -390,6 +449,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>listAlbumsByGenre</h4> <pre>public static void listAlbumsByGenre()</pre> +<div class="block">listAlbumsByGenre is called by the "AG" command in order to list the albums sorted by the genre of their songs.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Album.html#getGenre--"><code>Album.getGenre()</code></a></dd> +</dl> </li> </ul> <a name="listAudioBooksByAuthor--"> @@ -399,6 +463,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>listAudioBooksByAuthor</h4> <pre>public static void listAudioBooksByAuthor()</pre> +<div class="block">listAudioBooksByAuthor is called by the "BA" command in order to list the audiobooks sorted by authors.</div> </li> </ul> <a name="extract-java.lang.String-"> @@ -412,6 +477,8 @@ extends java.lang.Object</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>filename</code> - String</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>ArrayList</dd> </dl> </li> </ul> @@ -424,6 +491,13 @@ extends java.lang.Object</pre> <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> +<div class="block">addSongToAlbum is called by the "+" command in order to add a song to an album.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - Scanner</dd> +<dd><code>albums</code> - ArrayList</dd> +<dd><code>songs</code> - ArrayList</dd> +</dl> </li> </ul> <a name="delPlaylist-java.util.ArrayList-"> @@ -433,6 +507,13 @@ extends java.lang.Object</pre> <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> +<div class="block">delPlaylist is called by the "-" command in order to delete a playlist.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>playlists</code> - ArrayList</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>playlists ArrayList</dd> +</dl> </li> </ul> <a name="contentOfPlaylist-java.util.ArrayList-"> @@ -442,6 +523,11 @@ extends java.lang.Object</pre> <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> +<div class="block">contentOfPlaylist is called by the "PC" command in order to display the content of a chosen playlist.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>playlists</code> - ArrayList</dd> +</dl> </li> </ul> <a name="contentOfAlbum-java.util.ArrayList-"> @@ -451,6 +537,11 @@ extends java.lang.Object</pre> <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> +<div class="block">contentOfAlbum is called by the "AC" command in order to display the content of a chosen album.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>albums</code> - ArrayList</dd> +</dl> </li> </ul> <a name="main-java.lang.String:A-"> @@ -460,6 +551,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>main</h4> <pre>public static void main(java.lang.String[] args)</pre> +<div class="block">The main method is used to launch the app.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - String[]</dd> +</dl> </li> </ul> </li> |