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/index-all.html | |
| parent | de39259ada4f75ac987f9bd8f0674ebede75a0de (diff) | |
Finishing javadoc
Diffstat (limited to 'javadoc/index-all.html')
| -rw-r--r-- | javadoc/index-all.html | 163 |
1 files changed, 115 insertions, 48 deletions
diff --git a/javadoc/index-all.html b/javadoc/index-all.html index 9359c45..fd4fc50 100644 --- a/javadoc/index-all.html +++ b/javadoc/index-all.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>Index</title> <meta name="date" content="2020-12-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> @@ -74,15 +74,15 @@ <dl> <dt><span class="memberNameLink"><a href="jMusicHub.html#addAlbum-java.util.Scanner-">addAlbum(Scanner)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> <dd> -<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> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#addAudioBook-java.util.Scanner-">addAudioBook(Scanner)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> <dd> -<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> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#addPlaylist-java.util.Scanner-java.util.ArrayList-java.util.ArrayList-">addPlaylist(Scanner, ArrayList<Song>, ArrayList<AudioBook>)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> <dd> -<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> </dd> <dt><span class="memberNameLink"><a href="Album.html#addSong-Song-">addSong(Song)</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> @@ -90,10 +90,12 @@ </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#addSong-java.util.Scanner-">addSong(Scanner)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> <dd> -<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> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#addSongToAlbum-java.util.Scanner-java.util.ArrayList-java.util.ArrayList-">addSongToAlbum(Scanner, ArrayList<Album>, ArrayList<Song>)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">addSongToAlbum is called by the "+" command in order to add a song to an album.</div> +</dd> <dt><a href="Album.html" title="class in <Unnamed>"><span class="typeNameLink">Album</span></a> - Class in <a href="package-summary.html"><Unnamed></a></dt> <dd> <div class="block">The album class is used to create albums containing songs added after its creation and the creation of the songs.</div> @@ -121,9 +123,13 @@ <div class="block">The Category enum is used by audiobooks as an attribute.</div> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#contentOfAlbum-java.util.ArrayList-">contentOfAlbum(ArrayList<Album>)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">contentOfAlbum is called by the "AC" command in order to display the content of a chosen album.</div> +</dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#contentOfPlaylist-java.util.ArrayList-">contentOfPlaylist(ArrayList<Playlist>)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">contentOfPlaylist is called by the "PC" command in order to display the content of a chosen playlist.</div> +</dd> </dl> <a name="I:D"> <!-- --> @@ -131,7 +137,9 @@ <h2 class="title">D</h2> <dl> <dt><span class="memberNameLink"><a href="jMusicHub.html#delPlaylist-java.util.ArrayList-">delPlaylist(ArrayList<Playlist>)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">delPlaylist is called by the "-" command in order to delete a playlist.</div> +</dd> </dl> <a name="I:E"> <!-- --> @@ -157,9 +165,13 @@ <div class="block">This method is used to give the artist of the album.</div> </dd> <dt><span class="memberNameLink"><a href="Song.html#getArtist--">getArtist()</a></span> - Method in class <a href="Song.html" title="class in <Unnamed>">Song</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the artist of the song.</div> +</dd> <dt><span class="memberNameLink"><a href="Playlist.html#getAudioBooks--">getAudioBooks()</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.</div> +</dd> <dt><span class="memberNameLink"><a href="AudioBook.html#getAuthor--">getAuthor()</a></span> - Method in class <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a></dt> <dd> <div class="block">This method is used to give the author of the audiobook.</div> @@ -169,7 +181,9 @@ <div class="block">This method is used to give the category of the audiobook.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#getContent--">getContent()</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the content path of the element.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#getDate--">getDate()</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">This method is used to give the date of release of the album.</div> @@ -179,37 +193,53 @@ <div class="block">This method is used to give the duration of the album.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#getDuration--">getDuration()</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the duration of the element.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#getGenre--">getGenre()</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">This method is used for the AG command in jMusicHub.</div> </dd> <dt><span class="memberNameLink"><a href="Song.html#getGenre--">getGenre()</a></span> - Method in class <a href="Song.html" title="class in <Unnamed>">Song</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the genre of the song.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#getId--">getId()</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">This method is used to give the id of the album.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#getId--">getId()</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the id of the element.</div> +</dd> <dt><span class="memberNameLink"><a href="Playlist.html#getId--">getId()</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the id of the playlist.</div> +</dd> <dt><span class="memberNameLink"><a href="AudioBook.html#getLanguage--">getLanguage()</a></span> - Method in class <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a></dt> <dd> <div class="block">This method is used to give the language of the audiobook.</div> </dd> <dt><span class="memberNameLink"><a href="Playlist.html#getName--">getName()</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the name of the playlist in uppercase.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#getSongs--">getSongs()</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to print the each songs contained in the songs attribute of the album.</div> +</dd> <dt><span class="memberNameLink"><a href="Playlist.html#getSongs--">getSongs()</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to print the each songs contained in the songs attribute of the playlist.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#getTitle--">getTitle()</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">This method is used to give the title of the album.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#getTitle--">getTitle()</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">This method is used to give the title of the element.</div> +</dd> </dl> <a name="I:J"> <!-- --> @@ -218,10 +248,12 @@ <dl> <dt><a href="jMusicHub.html" title="class in <Unnamed>"><span class="typeNameLink">jMusicHub</span></a> - Class in <a href="package-summary.html"><Unnamed></a></dt> <dd> -<div class="block">The jMusicHub class is basically the app.</div> +<div class="block">The jMusicHub class is our main component.</div> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#jMusicHub--">jMusicHub()</a></span> - Constructor for class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">Constructor method, it is calling every methods and contains the command prompt.</div> +</dd> </dl> <a name="I:L"> <!-- --> @@ -233,17 +265,25 @@ <div class="block">The Language enum is used by audiobooks as an attribute.</div> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#listAlbumsByDate--">listAlbumsByDate()</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">listAlbumsByDate is called by the "AD" command in order to list the albums sorted by the date of release.</div> +</dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#listAlbumsByGenre--">listAlbumsByGenre()</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">listAlbumsByGenre is called by the "AG" command in order to list the albums sorted by the genre of their songs.</div> +</dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#listAudioBooksByAuthor--">listAudioBooksByAuthor()</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">listAudioBooksByAuthor is called by the "BA" command in order to list the audiobooks sorted by authors.</div> +</dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#listById-java.lang.String-">listById(String)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> <dd> <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> </dd> <dt><span class="memberNameLink"><a href="jMusicHub.html#listPlaylistsByName--">listPlaylistsByName()</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">listPlaylistsByName is called when using the "PN" command in order to list the playlists sorted by their name.</div> +</dd> </dl> <a name="I:M"> <!-- --> @@ -251,13 +291,17 @@ <h2 class="title">M</h2> <dl> <dt><span class="memberNameLink"><a href="jMusicHub.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> -<dd> </dd> +<dd> +<div class="block">The main method is used to launch the app.</div> +</dd> <dt><a href="MusicalElement.html" title="class in <Unnamed>"><span class="typeNameLink">MusicalElement</span></a> - Class in <a href="package-summary.html"><Unnamed></a></dt> <dd> <div class="block">The MusicalElement contains the base of songs and audiobooks.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#MusicalElement-java.lang.String-int-java.lang.String-">MusicalElement(String, int, String)</a></span> - Constructor for class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">Constructor method.</div> +</dd> </dl> <a name="I:P"> <!-- --> @@ -265,9 +309,13 @@ <h2 class="title">P</h2> <dl> <dt><a href="Playlist.html" title="class in <Unnamed>"><span class="typeNameLink">Playlist</span></a> - Class in <a href="package-summary.html"><Unnamed></a></dt> -<dd> </dd> +<dd> +<div class="block">The Playlist class is used to create playlists containing songs and audiobooks.</div> +</dd> <dt><span class="memberNameLink"><a href="Playlist.html#Playlist-java.lang.String-java.util.ArrayList-java.util.ArrayList-">Playlist(String, ArrayList<Song>, ArrayList<AudioBook>)</a></span> - Constructor for class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">Constructor method.</div> +</dd> </dl> <a name="I:S"> <!-- --> @@ -276,10 +324,7 @@ <dl> <dt><span class="memberNameLink"><a href="jMusicHub.html#save-java.lang.String-java.util.ArrayList-">save(String, ArrayList)</a></span> - Static method in class <a href="jMusicHub.html" title="class in <Unnamed>">jMusicHub</a></dt> <dd> -<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> </dd> <dt><span class="memberNameLink"><a href="Album.html#setArtist-java.lang.String-">setArtist(String)</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> @@ -287,50 +332,68 @@ </dd> <dt><span class="memberNameLink"><a href="AudioBook.html#setArtist-java.lang.String-">setArtist(String)</a></span> - Method in class <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a></dt> <dd> -<div class="block">Basic method to set the author of audiobook.</div> +<div class="block">Basic method to set the author of the audiobook.</div> </dd> <dt><span class="memberNameLink"><a href="Song.html#setArtist-java.lang.String-">setArtist(String)</a></span> - Method in class <a href="Song.html" title="class in <Unnamed>">Song</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the artist of the song.</div> +</dd> <dt><span class="memberNameLink"><a href="AudioBook.html#setCategory-Category-">setCategory(Category)</a></span> - Method in class <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a></dt> <dd> <div class="block">Basic method to set the category of the audiobook using the name method from the Category class.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#setContent-java.lang.String-">setContent(String)</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the content path of the element.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#setDate-java.util.Date-">setDate(Date)</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">Basic method to set the date of the album.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#setDuration-int-">setDuration(int)</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the duration of the element.</div> +</dd> <dt><span class="memberNameLink"><a href="AudioBook.html#setGenre-Language-">setGenre(Language)</a></span> - Method in class <a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a></dt> <dd> -<div class="block">Basic method to set the language of the audiobook using the name method from the Language object.</div> +<div class="block">Basic method to set the language of the audiobook using the name method from the Language class.</div> </dd> <dt><span class="memberNameLink"><a href="Song.html#setGenre-Genre-">setGenre(Genre)</a></span> - Method in class <a href="Song.html" title="class in <Unnamed>">Song</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the genre of the song using the name method from the Genre class.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#setId-int-">setId(int)</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">Basic method to set the id of the album.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#setId-int-">setId(int)</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the id of the element.</div> +</dd> <dt><span class="memberNameLink"><a href="Playlist.html#setId-int-">setId(int)</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the id of the playlist.</div> +</dd> <dt><span class="memberNameLink"><a href="Playlist.html#setName-java.lang.String-">setName(String)</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the name of the playlist.</div> +</dd> <dt><span class="memberNameLink"><a href="Album.html#setTitle-java.lang.String-">setTitle(String)</a></span> - Method in class <a href="Album.html" title="class in <Unnamed>">Album</a></dt> <dd> <div class="block">Basic method to set the title of the album.</div> </dd> <dt><span class="memberNameLink"><a href="MusicalElement.html#setTitle-java.lang.String-">setTitle(String)</a></span> - Method in class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to set the title of the element.</div> +</dd> <dt><a href="Song.html" title="class in <Unnamed>"><span class="typeNameLink">Song</span></a> - Class in <a href="package-summary.html"><Unnamed></a></dt> <dd> -<div class="block">Song is using instanciating MusicalElement and is Serializable.</div> +<div class="block">The Song class is used to create songs while extending MusicalElement.</div> </dd> <dt><span class="memberNameLink"><a href="Song.html#Song-java.lang.String-int-java.lang.String-java.lang.String-Genre-">Song(String, int, String, String, Genre)</a></span> - Constructor for class <a href="Song.html" title="class in <Unnamed>">Song</a></dt> -<dd> </dd> +<dd> +<div class="block">Constructor method.</div> +</dd> </dl> <a name="I:T"> <!-- --> @@ -346,9 +409,13 @@ <div class="block">Basic method to "configure" what does a print of this object actually does.</div> </dd> <dt><span class="memberNameLink"><a href="Playlist.html#toString--">toString()</a></span> - Method in class <a href="Playlist.html" title="class in <Unnamed>">Playlist</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to "configure" what does a print of this object actually does.</div> +</dd> <dt><span class="memberNameLink"><a href="Song.html#toString--">toString()</a></span> - Method in class <a href="Song.html" title="class in <Unnamed>">Song</a></dt> -<dd> </dd> +<dd> +<div class="block">Basic method to "configure" what does a print of this object actually does.</div> +</dd> </dl> <a name="I:V"> <!-- --> |