aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClyhtsuriva <aimeric@adjutor.xyz>2020-12-28 17:31:33 +0100
committerClyhtsuriva <aimeric@adjutor.xyz>2020-12-28 17:31:33 +0100
commit7c23f453d166d396451504e26fbb385afc0c4c13 (patch)
tree01aee8bfcd409dbaa3e90889295869903a4ab5d5
parentde39259ada4f75ac987f9bd8f0674ebede75a0de (diff)
Finishing javadoc
-rw-r--r--Album.java11
-rw-r--r--AudioBook.java8
-rw-r--r--MusicalElement.java104
-rw-r--r--Playlist.java85
-rw-r--r--README.md1
-rw-r--r--Song.java76
-rw-r--r--jMusicHub.java134
-rw-r--r--javadoc/Album.html10
-rw-r--r--javadoc/AudioBook.html14
-rw-r--r--javadoc/Category.html2
-rw-r--r--javadoc/Genre.html2
-rw-r--r--javadoc/Language.html2
-rw-r--r--javadoc/MusicalElement.html94
-rw-r--r--javadoc/Playlist.html75
-rw-r--r--javadoc/Song.html69
-rw-r--r--javadoc/allclasses-frame.html2
-rw-r--r--javadoc/allclasses-noframe.html2
-rw-r--r--javadoc/constant-values.html2
-rw-r--r--javadoc/deprecated-list.html2
-rw-r--r--javadoc/help-doc.html2
-rw-r--r--javadoc/index-all.html163
-rw-r--r--javadoc/index.html2
-rw-r--r--javadoc/jMusicHub.html162
-rw-r--r--javadoc/overview-tree.html2
-rw-r--r--javadoc/package-frame.html2
-rw-r--r--javadoc/package-summary.html10
-rw-r--r--javadoc/package-tree.html2
-rw-r--r--javadoc/serialized-form.html2
28 files changed, 858 insertions, 184 deletions
diff --git a/Album.java b/Album.java
index 71bf0d7..7b30ca1 100644
--- a/Album.java
+++ b/Album.java
@@ -18,6 +18,7 @@ import java.io.Serializable;
*
* @version 1.0
*
+ * @see Song
* @author Aimeric ADJUTOR
*/
@@ -54,7 +55,7 @@ public class Album implements Serializable {
*
* @return It returns the id, which is an int.
*
- * @author Aimeric ADJUTOR
+ * @author Aimeric ADJUTOR
* */
public int getId(){return id;}
@@ -99,6 +100,12 @@ public class Album implements Serializable {
* @author Aimeric ADJUTOR
* */
public Date getDate(){return date;}
+
+/**
+ * This method is used to print the each songs contained in the songs attribute of the album.
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void getSongs(){
for ( Song s : songs ){
System.out.println(s);
@@ -135,7 +142,7 @@ public class Album implements Serializable {
/**
* Basic method to set the title of the album.
*
- *@param title String
+ * @param title String
*
* @author Aimeric ADJUTOR
* */
diff --git a/AudioBook.java b/AudioBook.java
index 1e6f0e3..a4888bf 100644
--- a/AudioBook.java
+++ b/AudioBook.java
@@ -58,7 +58,7 @@ public class AudioBook extends MusicalElement {
/**
* This method is used to give the language of the audiobook.
*
- * @return It returns the language, which is a String because the constructor use the name method of the Language object.
+ * @return It returns the language, which is a String because the constructor use the name method of the Language class.
*
* @see Language
* @author Aimeric ADJUTOR
@@ -68,7 +68,7 @@ public class AudioBook extends MusicalElement {
/**
* This method is used to give the category of the audiobook.
*
- * @return It returns the category, which is a String because the constructor use the name method of the Category object.
+ * @return It returns the category, which is a String because the constructor use the name method of the Category class.
*
* @see Category
* @author Aimeric ADJUTOR
@@ -76,7 +76,7 @@ public class AudioBook extends MusicalElement {
public String getCategory(){return category;}
/**
- * Basic method to set the author of audiobook.
+ * Basic method to set the author of the audiobook.
*
* @param author String
*
@@ -85,7 +85,7 @@ public class AudioBook extends MusicalElement {
public void setArtist(String author){this.author=author;}
/**
- * Basic method to set the language of the audiobook using the name method from the Language object.
+ * Basic method to set the language of the audiobook using the name method from the Language class.
*
* @param language Language
*
diff --git a/MusicalElement.java b/MusicalElement.java
index 9094913..fee560e 100644
--- a/MusicalElement.java
+++ b/MusicalElement.java
@@ -1,18 +1,42 @@
-import java.io.Serializable;
+/*
+ * Name : MusicalElement
+ *
+ * Description : The MusicalElement contains the base of songs and audiobooks.
+ *
+ * Version : 1.0
+ *
+ * Date : 28/12/2020
+ *
+ * Copyright : Aimeric ADJUTOR
+ */
-/** The MusicalElement contains the base of songs and audiobooks.
- * It is the abstract class they will take.
- * We use the classical get and set here.
- * Get is used to return the said value.
- * Set is used to modify the later.*/
+import java.io.Serializable;
+/**
+ * The MusicalElement contains the base of songs and audiobooks.
+ * It's the abstract class they will extend.
+ *
+ * @version 1.0
+ *
+ * @see Song
+ * @see AudioBook
+ * @author Aimeric ADJUTOR
+ * */
public abstract class MusicalElement implements Serializable {
//Our vars
private int id, duration;
private String title, content;
-
+/**
+ * Constructor method.
+ *
+ * @param title String
+ * @param duration int
+ * @param content String, path to the mp3 file
+ *
+ * @author Aimeric ADJUTOR
+ * */
public MusicalElement(String title, int duration, String content) {
this.title=title;
this.duration=duration;
@@ -20,17 +44,77 @@ public abstract class MusicalElement implements Serializable {
}
//the gets
+/**
+ * This method is used to give the id of the element.
+ *
+ * @return id int
+ *
+ * @author Aimeric ADJUTOR
+ * */
public int getId(){return id;}
+
+/**
+ * This method is used to give the title of the element.
+ *
+ * @return title String
+ *
+ * @author Aimeric ADJUTOR
+ * */
public String getTitle(){return title;}
+
+/**
+ * This method is used to give the duration of the element.
+ *
+ * @return duration int
+ *
+ * @author Aimeric ADJUTOR
+ * */
public int getDuration(){return duration;}
+
+/**
+ * This method is used to give the content path of the element.
+ *
+ * @return content String
+ *
+ * @author Aimeric ADJUTOR
+ * */
public String getContent(){return content;}
//the sets
+
+/**
+ * Basic method to set the id of the element.
+ *
+ * @param id int
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void setId(int id){this.id=id;}
- public void setTitle(String title){this.title=title;}
- public void setDuration(int duration){this.duration=duration;}
- public void setContent(String content){this.content=content;}
+/**
+ * Basic method to set the title of the element.
+ *
+ * @param title String
+ *
+ * @author Aimeric ADJUTOR
+ * */
+ public void setTitle(String title){this.title=title;}
+/**
+ * Basic method to set the duration of the element.
+ *
+ * @param duration int
+ *
+ * @author Aimeric ADJUTOR
+ * */
+ public void setDuration(int duration){this.duration=duration;}
+/**
+ * Basic method to set the content path of the element.
+ *
+ * @param content String
+ *
+ * @author Aimeric ADJUTOR
+ * */
+ public void setContent(String content){this.content=content;}
}
diff --git a/Playlist.java b/Playlist.java
index fc1ea94..94cfdd6 100644
--- a/Playlist.java
+++ b/Playlist.java
@@ -1,6 +1,27 @@
+/*
+ * Name : Playlist
+ *
+ * Description : The Playlist class is used to create playlists containing songs and audiobooks.
+ *
+ * Version : 1.0
+ *
+ * Date : 28/12/2020
+ *
+ * Copyright : Aimeric ADJUTOR
+ */
+
import java.util.ArrayList;
import java.io.Serializable;
+/**
+ * The Playlist class is used to create playlists containing songs and audiobooks.
+ *
+ * @version 1.0
+ * @see Song
+ * @see AudioBook
+ * @author Aimeric ADJUTOR
+ */
+
public class Playlist implements Serializable {
private static final long serialVersionUID = 6021717365357635741L;
@@ -9,19 +30,59 @@ public class Playlist implements Serializable {
private ArrayList<Song> songs = new ArrayList<Song>();
private ArrayList<AudioBook> audiobooks = new ArrayList<AudioBook>();
+/**
+ * Constructor method.
+ *
+ * @param name String
+ * @param songs ArrayList
+ * @param audiobooks ArrayList
+ *
+ * @see Song
+ * @see AudioBook
+ *
+ * @author Aimeric ADJUTOR
+ * */
public Playlist(String name, ArrayList<Song> songs, ArrayList<AudioBook> audiobooks) {
this.name=name;
this.songs=songs;
this.audiobooks=audiobooks;
}
+/**
+ * This method is used to give the id of the playlist.
+ *
+ * @return id int
+ *
+ * @author Aimeric ADJUTOR
+ * */
public int getId(){return id;}
- public String getName(){return name.toUpperCase();} //using toUpperCase method because the way I sort by name sort he upper case then the lower case, which is inconvenient.
+
+/**
+ * This method is used to give the name of the playlist in uppercase.
+ * Using toUpperCase method because the way I sort by name sorts the upper case then the lower case, which is inconvenient.
+ *
+ * @return name.toUpperCase String
+ *
+ * @author Aimeric ADJUTOR
+ * */
+ public String getName(){return name.toUpperCase();}
+
+/**
+ * This method is used to print the each songs contained in the songs attribute of the playlist.
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void getSongs(){
for ( Song s : songs ){
System.out.println(s);
}
}
+
+/**
+ * This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void getAudioBooks(){
for (AudioBook b : audiobooks ){
System.out.println(b);
@@ -29,9 +90,31 @@ public class Playlist implements Serializable {
}
+/**
+ * Basic method to set the id of the playlist.
+ *
+ * @param id int
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void setId(int id){this.id=id;}
+
+/**
+ * Basic method to set the name of the playlist.
+ *
+ * @param name String
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void setName(String name){this.name=name;}
+/**
+ * Basic method to "configure" what does a print of this object actually does.
+ *
+ * @return String, using the object's methods
+ *
+ * @author Aimeric ADJUTOR
+ * */
public String toString() {
return "Id : "+getId()+"\nName : "+getName();
}
diff --git a/README.md b/README.md
index 3120585..740bb6b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
OOP project in Java done in my first year, first semester at ESIEA.
TO DO :
- - Generating the javadoc
- Doing the UML Diagramm
- Doing the report
- Sending in the whole thing
diff --git a/Song.java b/Song.java
index 322f606..a476d2c 100644
--- a/Song.java
+++ b/Song.java
@@ -1,23 +1,93 @@
-/**
- * Song is using instanciating MusicalElement and is Serializable.
- * */
+/*
+ * Name : Song
+ *
+ * Description : The Song class is used to create songs while extending MusicalElement
+ *
+ * Version : 1.0
+ *
+ * Date : 28/12/2020
+ *
+ * Copyright : Aimeric ADJUTOR
+ */
+/**
+ * The Song class is used to create songs while extending MusicalElement.
+ *
+ * @version 1.0
+ *
+ * @see MusicalElement
+ * @author Aimeric ADJUTOR
+ */
public class Song extends MusicalElement{
private static final long serialVersionUID = 2112880640160601826L;
private String artist, genre;
+/**
+ * Constructor method.
+ *
+ * @param title String
+ * @param duration int
+ * @param content String, path to the mp3 file
+ * @param artist String
+ * @param genre Genre
+ *
+ * @see Genre
+ *
+ * @author Aimeric ADJUTOR
+ * */
public Song(String title, int duration, String content, String artist, Genre genre) {
super(title, duration, content);
this.artist=artist;
this.genre=genre.name();
}
+/**
+ * This method is used to give the artist of the song.
+ *
+ * @return artist String
+ *
+ * @author Aimeric ADJUTOR
+ * */
public String getArtist(){return artist;}
+
+/**
+ * This method is used to give the genre of the song.
+ *
+ * @return It returns the genre, which is a String because the constructor use the name method of the Genre class.
+ *
+ * @see Genre
+ * @author Aimeric ADJUTOR
+ * */
public String getGenre(){return genre;}
+
+/**
+ * Basic method to set the artist of the song.
+ *
+ * @param artist String
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void setArtist(String artist){this.artist=artist;}
+
+/**
+ * Basic method to set the genre of the song using the name method from the Genre class.
+ *
+ * @param genre Genre
+ *
+ * @see Genre
+ *
+ * @author Aimeric ADJUTOR
+ * */
public void setGenre(Genre genre){this.genre=genre.name();}
+/**
+ * Basic method to "configure" what does a print of this object actually does.
+ *
+ * @return String, using the object's methods
+ *
+ * @author Aimeric ADJUTOR
+ * */
public String toString() {
return "Id : "+getId()+"\nTitle : "+getTitle()+"\nDuration : "+getDuration()+"\nContent : "+getContent()+"\nArtist : "+getArtist()+"\nGenre : "+getGenre();
}
diff --git a/jMusicHub.java b/jMusicHub.java
index 363695e..56bb957 100644
--- a/jMusicHub.java
+++ b/jMusicHub.java
@@ -1,21 +1,37 @@
+/*
+ * Name : jMusicHub
+ *
+ * Description : The jMusicHub class is our main component. It's basically the app we use to launch the whole process
+ *
+ * Version : 1.0
+ *
+ * Date : 28/12/2020
+ *
+ * Copyright : Aimeric ADJUTOR
+ */
+
import java.util.*;
import java.io.*;
import java.text.*;
/**
- * The jMusicHub class is basically the app.
- * It is used to launch the whole process.
+ * The jMusicHub class is our main component.
+ * It's basically the app we use to launch the whole process.
*
* @author Aimeric ADJUTOR
* @version 1.0
* @since 2020-11-13
* */
-
public class jMusicHub {
/**
- * addSong is used to add songs thanks to the "c" option
- * @param scan Scanner Object
+ * 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.
+ * @param scan Scanner
+ * @return newSong Song
+ * @see Song
+ * @author Aimeric ADJUTOR
*/
public static Song addSong(Scanner scan){
System.out.println("Adding a song...");
@@ -54,8 +70,13 @@ public class jMusicHub {
}
/**
- * addAudioBook is used to add songs thanks to the "l" option
- * @param scan Scanner Object
+ * 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.
+ * @param scan Scanner
+ * @return newAudioBook AudioBook
+ * @see AudioBook
+ * @author Aimeric ADJUTOR
*/
public static AudioBook addAudioBook(Scanner scan){
System.out.println("Adding an audiobook...");
@@ -99,8 +120,13 @@ public class jMusicHub {
}
/**
- * addAlbum is used to add albums thanks to the "a" option
- * @param scan Scanner Object
+ * 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.
+ * @param scan Scanner
+ * @return newAlbum Album
+ * @see Album
+ * @author Aimeric ADJUTOR
*/
public static Album addAlbum(Scanner scan){
System.out.println("\n[DISCLAIMER : You have to register the songs after creating (a) and saving (s) the albums]\n");
@@ -140,8 +166,15 @@ public class jMusicHub {
}
/**
- * addPlaylist is used to add playlist thanks to the "p" option
- * @param scan Scanner Object
+ * 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.
+ * @param scan Scanner
+ * @param songs ArrayList
+ * @param audiobooks ArrayList
+ * @return newPlaylist Playlist
+ * @see Playlist
+ * @author Aimeric ADJUTOR
*/
public static Playlist addPlaylist(Scanner scan, ArrayList<Song> songs, ArrayList<AudioBook> audiobooks){
String userInput;
@@ -206,12 +239,11 @@ public class jMusicHub {
}
/**
- * 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.
+ * save is used by the command "s".
+ * It is used to serialize (save) arrays of a list into the type's file.
* @param filename String
* @param elements ArrayList
+ * @author Aimeric ADJUTOR
* */
@SuppressWarnings ("rawtypes")
public static void save(String filename, ArrayList elements){
@@ -239,8 +271,8 @@ public class jMusicHub {
/**
* list is called when using the "AB", "S", "A" and "P" commands in order to list the elements in respective files.
* @param filename String
+ * @author Aimeric ADJUTOR
* */
-
public static void listById(String filename){
// Deserialization
@@ -308,6 +340,12 @@ public class jMusicHub {
catch (ClassNotFoundException ex) {System.out.println("ClassNotFoundException is caught");}
}
+/**
+ * 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.
+ * @see Playlist#getName
+ * @author Aimeric ADJUTOR
+ * */
public static void listPlaylistsByName(){
String filename = "playlists";
try {
@@ -330,7 +368,10 @@ public class jMusicHub {
catch (IOException ex) {System.out.println(filename+ " file missing.");}
catch (ClassNotFoundException ex) {System.out.println("ClassNotFoundException is caught");}
}
-
+/**
+ * listAlbumsByDate is called by the "AD" command in order to list the albums sorted by the date of release.
+ * @author Aimeric ADJUTOR
+ * */
public static void listAlbumsByDate(){
String filename = "albums";
try {
@@ -354,6 +395,11 @@ public class jMusicHub {
catch (ClassNotFoundException ex) {System.out.println("ClassNotFoundException is caught");}
}
+/**
+ * listAlbumsByGenre is called by the "AG" command in order to list the albums sorted by the genre of their songs.
+ * @see Album#getGenre
+ * @author Aimeric ADJUTOR
+ * */
public static void listAlbumsByGenre(){
String filename = "albums";
try {
@@ -376,7 +422,10 @@ public static void listAlbumsByGenre(){
catch (IOException ex) {System.out.println(filename+ " file missing.");}
catch (ClassNotFoundException ex) {System.out.println("ClassNotFoundException is caught");}
}
-
+/**
+ * listAudioBooksByAuthor is called by the "BA" command in order to list the audiobooks sorted by authors.
+ * @author Aimeric ADJUTOR
+ * */
public static void listAudioBooksByAuthor(){
String filename = "audiobooks";
try {
@@ -403,6 +452,8 @@ public static void listAudioBooksByAuthor(){
/**
* Extract is used to print the content of the files and put them in the ArrayList used to add elements.
* @param filename String
+ * @return ArrayList
+ * @author Aimeric ADJUTOR
* */
@SuppressWarnings("rawtypes")
public static ArrayList extract(String filename){
@@ -484,6 +535,13 @@ public static void listAudioBooksByAuthor(){
}
}
+/**
+ * addSongToAlbum is called by the "+" command in order to add a song to an album.
+ * @param scan Scanner
+ * @param albums ArrayList
+ * @param songs ArrayList
+ * @author Aimeric ADJUTOR
+ * */
public static void addSongToAlbum(Scanner scan, ArrayList<Album> albums, ArrayList<Song> songs){
System.out.println("Adding a existing song to an existing album...");
listById("songs");
@@ -507,6 +565,12 @@ public static void listAudioBooksByAuthor(){
}
}
+/**
+ * delPlaylist is called by the "-" command in order to delete a playlist.
+ * @param playlists ArrayList
+ * @return playlists ArrayList
+ * @author Aimeric ADJUTOR
+ * */
public static ArrayList<Playlist> delPlaylist(ArrayList<Playlist> playlists){
Scanner scan = new Scanner(System.in);
listById("playlists");
@@ -534,6 +598,11 @@ public static void listAudioBooksByAuthor(){
return playlists;
}
+/**
+ * contentOfPlaylist is called by the "PC" command in order to display the content of a chosen playlist.
+ * @param playlists ArrayList
+ * @author Aimeric ADJUTOR
+ * */
public static void contentOfPlaylist(ArrayList<Playlist> playlists){
Scanner scan = new Scanner(System.in);
listById("playlists");
@@ -550,7 +619,11 @@ public static void listAudioBooksByAuthor(){
}
}
}
-
+/**
+ * contentOfAlbum is called by the "AC" command in order to display the content of a chosen album.
+ * @param albums ArrayList
+ * @author Aimeric ADJUTOR
+ * */
public static void contentOfAlbum(ArrayList<Album> albums){
Scanner scan = new Scanner(System.in);
listById("albums");
@@ -566,6 +639,18 @@ public static void listAudioBooksByAuthor(){
}
}
+/**
+ * Constructor method, it is calling every methods and contains the command prompt.
+ * @see Song
+ * @see AudioBook
+ * @see Album
+ * @see Playlist
+ * @see Genre
+ * @see Category
+ * @see Language
+ *
+ * @author Aimeric ADJUTOR
+ * */
public jMusicHub() {
System.out.println("Welcome to the jMusicHub !\n");
@@ -592,7 +677,7 @@ public static void listAudioBooksByAuthor(){
switch(userInput) {
case "h" : //page help
- System.out.printf("c: add a new song\na: add a new album\n+: add an existing song to an album\nl: add a new audiobook\n\np: create a new playlist from existing songs and audiobooks\n-: delete a playlist\n\ns: save playlists, albums, songs and audiobooks into the concerned files\n\nS: List all your saved songs\nB: List all your saved audiobooks\nA: List all your saved albums\nP: List all your saved playlists\n\nPS: Print playlists sorted by their name\nPC: Print the content of a playlist\nAD: Print albums sorted by their date of release\nAG: Print albums sorted by their genre\nAC: Print the content of an album\nBA: Print audiobooks sorted by their author's name\n\nh: print this help screen\nq: quit the program\n");
+ System.out.printf("c: add a new song\na: add a new album\n+: add an existing song to an album\nl: add a new audiobook\n\np: create a new playlist from existing songs and audiobooks\n-: delete a playlist\n\ns: save playlists, albums, songs and audiobooks into the concerned files\n\nS: List all your saved songs\nB: List all your saved audiobooks\nA: List all your saved albums\nP: List all your saved playlists\n\nPN: Print playlists sorted by their name\nPC: Print the content of a playlist\nAD: Print albums sorted by their date of release\nAG: Print albums sorted by their genre\nAC: Print the content of an album\nBA: Print audiobooks sorted by their author's name\n\nh: print this help screen\nq: quit the program\n");
break;
case "q" : //quit
@@ -716,7 +801,7 @@ public static void listAudioBooksByAuthor(){
case "P": //print playlists sorted by id
listById("playlists");
break;
- case "PS": //print playlists sorted by their name
+ case "PN": //print playlists sorted by their name
listPlaylistsByName();
break;
case "PC": //display content of a chosen playlist
@@ -739,6 +824,13 @@ public static void listAudioBooksByAuthor(){
}
} while(!userInput.equals("q"));
}
+
+/**
+ * The main method is used to launch the app.
+ * @param args String[]
+ * @author Aimeric ADJUTOR
+ * */
+
public static void main(String[] args) {
new jMusicHub();
}
diff --git a/javadoc/Album.html b/javadoc/Album.html
index 6854986..0b51dd4 100644
--- a/javadoc/Album.html
+++ b/javadoc/Album.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:45 CET 2020 -->
<title>Album</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -116,7 +116,8 @@ implements java.io.Serializable</pre>
<div class="block">The album class is used to create albums containing songs added after its creation and the creation of the songs.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a href="serialized-form.html#Album">Serialized Form</a></dd>
+<dd><a href="Song.html" title="class in &lt;Unnamed&gt;"><code>Song</code></a>,
+<a href="serialized-form.html#Album">Serialized Form</a></dd>
</dl>
</li>
</ul>
@@ -197,7 +198,9 @@ implements java.io.Serializable</pre>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getSongs--">getSongs</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getSongs--">getSongs</a></span>()</code>
+<div class="block">This method is used to print the each songs contained in the songs attribute of the album.</div>
+</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
@@ -369,6 +372,7 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getSongs</h4>
<pre>public&nbsp;void&nbsp;getSongs()</pre>
+<div class="block">This method is used to print the each songs contained in the songs attribute of the album.</div>
</li>
</ul>
<a name="getGenre--">
diff --git a/javadoc/AudioBook.html b/javadoc/AudioBook.html
index c8ba92e..273279c 100644
--- a/javadoc/AudioBook.html
+++ b/javadoc/AudioBook.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>AudioBook</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -186,7 +186,7 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="AudioBook.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String&nbsp;author)</code>
-<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>
</td>
</tr>
<tr id="i4" class="altColor">
@@ -198,7 +198,7 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="AudioBook.html#setGenre-Language-">setGenre</a></span>(<a href="Language.html" title="enum in &lt;Unnamed&gt;">Language</a>&nbsp;language)</code>
-<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>
</td>
</tr>
<tr id="i6" class="altColor">
@@ -295,7 +295,7 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<div class="block">This method is used to give the language of the audiobook.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>It returns the language, which is a String because the constructor use the name method of the Language object.</dd>
+<dd>It returns the language, which is a String because the constructor use the name method of the Language class.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Language.html" title="enum in &lt;Unnamed&gt;"><code>Language</code></a></dd>
</dl>
@@ -311,7 +311,7 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<div class="block">This method is used to give the category of the audiobook.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>It returns the category, which is a String because the constructor use the name method of the Category object.</dd>
+<dd>It returns the category, which is a String because the constructor use the name method of the Category class.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Category.html" title="enum in &lt;Unnamed&gt;"><code>Category</code></a></dd>
</dl>
@@ -324,7 +324,7 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>setArtist</h4>
<pre>public&nbsp;void&nbsp;setArtist(java.lang.String&nbsp;author)</pre>
-<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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>author</code> - String</dd>
@@ -338,7 +338,7 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>setGenre</h4>
<pre>public&nbsp;void&nbsp;setGenre(<a href="Language.html" title="enum in &lt;Unnamed&gt;">Language</a>&nbsp;language)</pre>
-<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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>language</code> - Language</dd>
diff --git a/javadoc/Category.html b/javadoc/Category.html
index 6894769..48f95b1 100644
--- a/javadoc/Category.html
+++ b/javadoc/Category.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>Category</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/Genre.html b/javadoc/Genre.html
index f66b62a..3865929 100644
--- a/javadoc/Genre.html
+++ b/javadoc/Genre.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>Genre</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/Language.html b/javadoc/Language.html
index 4f7f5e1..905a321 100644
--- a/javadoc/Language.html
+++ b/javadoc/Language.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>Language</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/MusicalElement.html b/javadoc/MusicalElement.html
index fa4e8c3..e1262dc 100644
--- a/javadoc/MusicalElement.html
+++ b/javadoc/MusicalElement.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>MusicalElement</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -118,13 +118,12 @@ var activeTableTab = "activeTableTab";
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">The MusicalElement contains the base of songs and audiobooks.
- It is the abstract class they will take.
- We use the classical get and set here.
- Get is used to return the said value.
- Set is used to modify the later.</div>
+ It's the abstract class they will extend.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a href="serialized-form.html#MusicalElement">Serialized Form</a></dd>
+<dd><a href="Song.html" title="class in &lt;Unnamed&gt;"><code>Song</code></a>,
+<a href="AudioBook.html" title="class in &lt;Unnamed&gt;"><code>AudioBook</code></a>,
+<a href="serialized-form.html#MusicalElement">Serialized Form</a></dd>
</dl>
</li>
</ul>
@@ -146,7 +145,9 @@ implements java.io.Serializable</pre>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="MusicalElement.html#MusicalElement-java.lang.String-int-java.lang.String-">MusicalElement</a></span>(java.lang.String&nbsp;title,
int&nbsp;duration,
- java.lang.String&nbsp;content)</code>&nbsp;</td>
+ java.lang.String&nbsp;content)</code>
+<div class="block">Constructor method.</div>
+</td>
</tr>
</table>
</li>
@@ -165,35 +166,51 @@ implements java.io.Serializable</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getContent--">getContent</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getContent--">getContent</a></span>()</code>
+<div class="block">This method is used to give the content path of the element.</div>
+</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getDuration--">getDuration</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getDuration--">getDuration</a></span>()</code>
+<div class="block">This method is used to give the duration of the element.</div>
+</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getId--">getId</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getId--">getId</a></span>()</code>
+<div class="block">This method is used to give the id of the element.</div>
+</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getTitle--">getTitle</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getTitle--">getTitle</a></span>()</code>
+<div class="block">This method is used to give the title of the element.</div>
+</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setContent-java.lang.String-">setContent</a></span>(java.lang.String&nbsp;content)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setContent-java.lang.String-">setContent</a></span>(java.lang.String&nbsp;content)</code>
+<div class="block">Basic method to set the content path of the element.</div>
+</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setDuration-int-">setDuration</a></span>(int&nbsp;duration)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setDuration-int-">setDuration</a></span>(int&nbsp;duration)</code>
+<div class="block">Basic method to set the duration of the element.</div>
+</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setId-int-">setId</a></span>(int&nbsp;id)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setId-int-">setId</a></span>(int&nbsp;id)</code>
+<div class="block">Basic method to set the id of the element.</div>
+</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String&nbsp;title)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String&nbsp;title)</code>
+<div class="block">Basic method to set the title of the element.</div>
+</td>
</tr>
</table>
<ul class="blockList">
@@ -226,6 +243,13 @@ implements java.io.Serializable</pre>
<pre>public&nbsp;MusicalElement(java.lang.String&nbsp;title,
int&nbsp;duration,
java.lang.String&nbsp;content)</pre>
+<div class="block">Constructor method.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>title</code> - String</dd>
+<dd><code>duration</code> - int</dd>
+<dd><code>content</code> - String, path to the mp3 file</dd>
+</dl>
</li>
</ul>
</li>
@@ -243,6 +267,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;int&nbsp;getId()</pre>
+<div class="block">This method is used to give the id of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>id int</dd>
+</dl>
</li>
</ul>
<a name="getTitle--">
@@ -252,6 +281,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getTitle</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTitle()</pre>
+<div class="block">This method is used to give the title of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>title String</dd>
+</dl>
</li>
</ul>
<a name="getDuration--">
@@ -261,6 +295,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getDuration</h4>
<pre>public&nbsp;int&nbsp;getDuration()</pre>
+<div class="block">This method is used to give the duration of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>duration int</dd>
+</dl>
</li>
</ul>
<a name="getContent--">
@@ -270,6 +309,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getContent</h4>
<pre>public&nbsp;java.lang.String&nbsp;getContent()</pre>
+<div class="block">This method is used to give the content path of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>content String</dd>
+</dl>
</li>
</ul>
<a name="setId-int-">
@@ -279,6 +323,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(int&nbsp;id)</pre>
+<div class="block">Basic method to set the id of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - int</dd>
+</dl>
</li>
</ul>
<a name="setTitle-java.lang.String-">
@@ -288,6 +337,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setTitle</h4>
<pre>public&nbsp;void&nbsp;setTitle(java.lang.String&nbsp;title)</pre>
+<div class="block">Basic method to set the title of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>title</code> - String</dd>
+</dl>
</li>
</ul>
<a name="setDuration-int-">
@@ -297,6 +351,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setDuration</h4>
<pre>public&nbsp;void&nbsp;setDuration(int&nbsp;duration)</pre>
+<div class="block">Basic method to set the duration of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>duration</code> - int</dd>
+</dl>
</li>
</ul>
<a name="setContent-java.lang.String-">
@@ -306,6 +365,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setContent</h4>
<pre>public&nbsp;void&nbsp;setContent(java.lang.String&nbsp;content)</pre>
+<div class="block">Basic method to set the content path of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>content</code> - String</dd>
+</dl>
</li>
</ul>
</li>
diff --git a/javadoc/Playlist.html b/javadoc/Playlist.html
index 56c9b27..1bc1c8d 100644
--- a/javadoc/Playlist.html
+++ b/javadoc/Playlist.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>Playlist</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -113,9 +113,12 @@ var activeTableTab = "activeTableTab";
<pre>public class <span class="typeNameLabel">Playlist</span>
extends java.lang.Object
implements java.io.Serializable</pre>
+<div class="block">The Playlist class is used to create playlists containing songs and audiobooks.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a href="serialized-form.html#Playlist">Serialized Form</a></dd>
+<dd><a href="Song.html" title="class in &lt;Unnamed&gt;"><code>Song</code></a>,
+<a href="AudioBook.html" title="class in &lt;Unnamed&gt;"><code>AudioBook</code></a>,
+<a href="serialized-form.html#Playlist">Serialized Form</a></dd>
</dl>
</li>
</ul>
@@ -137,7 +140,9 @@ implements java.io.Serializable</pre>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="Playlist.html#Playlist-java.lang.String-java.util.ArrayList-java.util.ArrayList-">Playlist</a></span>(java.lang.String&nbsp;name,
java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;songs,
- java.util.ArrayList&lt;<a href="AudioBook.html" title="class in &lt;Unnamed&gt;">AudioBook</a>&gt;&nbsp;audiobooks)</code>&nbsp;</td>
+ java.util.ArrayList&lt;<a href="AudioBook.html" title="class in &lt;Unnamed&gt;">AudioBook</a>&gt;&nbsp;audiobooks)</code>
+<div class="block">Constructor method.</div>
+</td>
</tr>
</table>
</li>
@@ -156,31 +161,45 @@ implements java.io.Serializable</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getAudioBooks--">getAudioBooks</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getAudioBooks--">getAudioBooks</a></span>()</code>
+<div class="block">This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.</div>
+</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getId--">getId</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getId--">getId</a></span>()</code>
+<div class="block">This method is used to give the id of the playlist.</div>
+</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getName--">getName</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getName--">getName</a></span>()</code>
+<div class="block">This method is used to give the name of the playlist in uppercase.</div>
+</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getSongs--">getSongs</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getSongs--">getSongs</a></span>()</code>
+<div class="block">This method is used to print the each songs contained in the songs attribute of the playlist.</div>
+</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setId-int-">setId</a></span>(int&nbsp;id)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setId-int-">setId</a></span>(int&nbsp;id)</code>
+<div class="block">Basic method to set the id of the playlist.</div>
+</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>
+<div class="block">Basic method to set the name of the playlist.</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="Playlist.html#toString--">toString</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#toString--">toString</a></span>()</code>
+<div class="block">Basic method to "configure" what does a print of this object actually does.</div>
+</td>
</tr>
</table>
<ul class="blockList">
@@ -213,6 +232,16 @@ implements java.io.Serializable</pre>
<pre>public&nbsp;Playlist(java.lang.String&nbsp;name,
java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;songs,
java.util.ArrayList&lt;<a href="AudioBook.html" title="class in &lt;Unnamed&gt;">AudioBook</a>&gt;&nbsp;audiobooks)</pre>
+<div class="block">Constructor method.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - String</dd>
+<dd><code>songs</code> - ArrayList</dd>
+<dd><code>audiobooks</code> - ArrayList</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Song.html" title="class in &lt;Unnamed&gt;"><code>Song</code></a>,
+<a href="AudioBook.html" title="class in &lt;Unnamed&gt;"><code>AudioBook</code></a></dd>
+</dl>
</li>
</ul>
</li>
@@ -230,6 +259,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;int&nbsp;getId()</pre>
+<div class="block">This method is used to give the id of the playlist.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>id int</dd>
+</dl>
</li>
</ul>
<a name="getName--">
@@ -239,6 +273,12 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
+<div class="block">This method is used to give the name of the playlist in uppercase.
+ Using toUpperCase method because the way I sort by name sorts the upper case then the lower case, which is inconvenient.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>name.toUpperCase String</dd>
+</dl>
</li>
</ul>
<a name="getSongs--">
@@ -248,6 +288,7 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getSongs</h4>
<pre>public&nbsp;void&nbsp;getSongs()</pre>
+<div class="block">This method is used to print the each songs contained in the songs attribute of the playlist.</div>
</li>
</ul>
<a name="getAudioBooks--">
@@ -257,6 +298,7 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getAudioBooks</h4>
<pre>public&nbsp;void&nbsp;getAudioBooks()</pre>
+<div class="block">This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.</div>
</li>
</ul>
<a name="setId-int-">
@@ -266,6 +308,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(int&nbsp;id)</pre>
+<div class="block">Basic method to set the id of the playlist.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - int</dd>
+</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
@@ -275,6 +322,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(java.lang.String&nbsp;name)</pre>
+<div class="block">Basic method to set the name of the playlist.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - String</dd>
+</dl>
</li>
</ul>
<a name="toString--">
@@ -284,9 +336,12 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
+<div class="block">Basic method to "configure" what does a print of this object actually does.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>String, using the object's methods</dd>
</dl>
</li>
</ul>
diff --git a/javadoc/Song.html b/javadoc/Song.html
index 3f1712f..a9de438 100644
--- a/javadoc/Song.html
+++ b/javadoc/Song.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>Song</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -117,10 +117,11 @@ var activeTableTab = "activeTableTab";
<br>
<pre>public class <span class="typeNameLabel">Song</span>
extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalElement</a></pre>
-<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>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a href="serialized-form.html#Song">Serialized Form</a></dd>
+<dd><a href="MusicalElement.html" title="class in &lt;Unnamed&gt;"><code>MusicalElement</code></a>,
+<a href="serialized-form.html#Song">Serialized Form</a></dd>
</dl>
</li>
</ul>
@@ -144,7 +145,9 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
int&nbsp;duration,
java.lang.String&nbsp;content,
java.lang.String&nbsp;artist,
- <a href="Genre.html" title="enum in &lt;Unnamed&gt;">Genre</a>&nbsp;genre)</code>&nbsp;</td>
+ <a href="Genre.html" title="enum in &lt;Unnamed&gt;">Genre</a>&nbsp;genre)</code>
+<div class="block">Constructor method.</div>
+</td>
</tr>
</table>
</li>
@@ -163,23 +166,33 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getArtist--">getArtist</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getArtist--">getArtist</a></span>()</code>
+<div class="block">This method is used to give the artist of the song.</div>
+</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getGenre--">getGenre</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getGenre--">getGenre</a></span>()</code>
+<div class="block">This method is used to give the genre of the song.</div>
+</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String&nbsp;artist)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String&nbsp;artist)</code>
+<div class="block">Basic method to set the artist of the song.</div>
+</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setGenre-Genre-">setGenre</a></span>(<a href="Genre.html" title="enum in &lt;Unnamed&gt;">Genre</a>&nbsp;genre)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setGenre-Genre-">setGenre</a></span>(<a href="Genre.html" title="enum in &lt;Unnamed&gt;">Genre</a>&nbsp;genre)</code>
+<div class="block">Basic method to set the genre of the song using the name method from the Genre class.</div>
+</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#toString--">toString</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#toString--">toString</a></span>()</code>
+<div class="block">Basic method to "configure" what does a print of this object actually does.</div>
+</td>
</tr>
</table>
<ul class="blockList">
@@ -221,6 +234,17 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
java.lang.String&nbsp;content,
java.lang.String&nbsp;artist,
<a href="Genre.html" title="enum in &lt;Unnamed&gt;">Genre</a>&nbsp;genre)</pre>
+<div class="block">Constructor method.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>title</code> - String</dd>
+<dd><code>duration</code> - int</dd>
+<dd><code>content</code> - String, path to the mp3 file</dd>
+<dd><code>artist</code> - String</dd>
+<dd><code>genre</code> - Genre</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Genre.html" title="enum in &lt;Unnamed&gt;"><code>Genre</code></a></dd>
+</dl>
</li>
</ul>
</li>
@@ -238,6 +262,11 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>getArtist</h4>
<pre>public&nbsp;java.lang.String&nbsp;getArtist()</pre>
+<div class="block">This method is used to give the artist of the song.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>artist String</dd>
+</dl>
</li>
</ul>
<a name="getGenre--">
@@ -247,6 +276,13 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>getGenre</h4>
<pre>public&nbsp;java.lang.String&nbsp;getGenre()</pre>
+<div class="block">This method is used to give the genre of the song.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>It returns the genre, which is a String because the constructor use the name method of the Genre class.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Genre.html" title="enum in &lt;Unnamed&gt;"><code>Genre</code></a></dd>
+</dl>
</li>
</ul>
<a name="setArtist-java.lang.String-">
@@ -256,6 +292,11 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>setArtist</h4>
<pre>public&nbsp;void&nbsp;setArtist(java.lang.String&nbsp;artist)</pre>
+<div class="block">Basic method to set the artist of the song.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>artist</code> - String</dd>
+</dl>
</li>
</ul>
<a name="setGenre-Genre-">
@@ -265,6 +306,13 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>setGenre</h4>
<pre>public&nbsp;void&nbsp;setGenre(<a href="Genre.html" title="enum in &lt;Unnamed&gt;">Genre</a>&nbsp;genre)</pre>
+<div class="block">Basic method to set the genre of the song using the name method from the Genre class.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>genre</code> - Genre</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Genre.html" title="enum in &lt;Unnamed&gt;"><code>Genre</code></a></dd>
+</dl>
</li>
</ul>
<a name="toString--">
@@ -274,9 +322,12 @@ extends <a href="MusicalElement.html" title="class in &lt;Unnamed&gt;">MusicalEl
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
+<div class="block">Basic method to "configure" what does a print of this object actually does.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>String, using the object's methods</dd>
</dl>
</li>
</ul>
diff --git a/javadoc/allclasses-frame.html b/javadoc/allclasses-frame.html
index 7b95261..761f06c 100644
--- a/javadoc/allclasses-frame.html
+++ b/javadoc/allclasses-frame.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>All Classes</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html
index e1d75f1..d01c0bc 100644
--- a/javadoc/allclasses-noframe.html
+++ b/javadoc/allclasses-noframe.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>All Classes</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html
index 9058d99..ac69117 100644
--- a/javadoc/constant-values.html
+++ b/javadoc/constant-values.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>Constant Field Values</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html
index 2324e28..76ea693 100644
--- a/javadoc/deprecated-list.html
+++ b/javadoc/deprecated-list.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>Deprecated List</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html
index 7ee1fe6..d5354cd 100644
--- a/javadoc/help-doc.html
+++ b/javadoc/help-doc.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>API Help</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">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&lt;Song&gt;, ArrayList&lt;AudioBook&gt;)</a></span> - Static method in class <a href="jMusicHub.html" title="class in &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">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&lt;Album&gt;, ArrayList&lt;Song&gt;)</a></span> - Static method in class <a href="jMusicHub.html" title="class in &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;"><span class="typeNameLink">Album</span></a> - Class in <a href="package-summary.html">&lt;Unnamed&gt;</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&lt;Album&gt;)</a></span> - Static method in class <a href="jMusicHub.html" title="class in &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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&lt;Playlist&gt;)</a></span> - Static method in class <a href="jMusicHub.html" title="class in &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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&lt;Playlist&gt;)</a></span> - Static method in class <a href="jMusicHub.html" title="class in &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Song</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">Song</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Album</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;"><span class="typeNameLink">jMusicHub</span></a> - Class in <a href="package-summary.html">&lt;Unnamed&gt;</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 &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">jMusicHub</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">The main method is used to launch the app.</div>
+</dd>
<dt><a href="MusicalElement.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">MusicalElement</span></a> - Class in <a href="package-summary.html">&lt;Unnamed&gt;</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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;"><span class="typeNameLink">Playlist</span></a> - Class in <a href="package-summary.html">&lt;Unnamed&gt;</a></dt>
-<dd>&nbsp;</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&lt;Song&gt;, ArrayList&lt;AudioBook&gt;)</a></span> - Constructor for class <a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">Song</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">Song</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">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 &lt;Unnamed&gt;">MusicalElement</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Basic method to set the title of the element.</div>
+</dd>
<dt><a href="Song.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Song</span></a> - Class in <a href="package-summary.html">&lt;Unnamed&gt;</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 &lt;Unnamed&gt;">Song</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Playlist</a></dt>
-<dd>&nbsp;</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 &lt;Unnamed&gt;">Song</a></dt>
-<dd>&nbsp;</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">
<!-- -->
diff --git a/javadoc/index.html b/javadoc/index.html
index 24dcdec..cd70d45 100644
--- a/javadoc/index.html
+++ b/javadoc/index.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>Generated Documentation (Untitled)</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
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>&nbsp;</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 &lt;Unnamed&gt;">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&nbsp;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 &lt;Unnamed&gt;">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&nbsp;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&nbsp;scan,
java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;songs,
java.util.ArrayList&lt;<a href="AudioBook.html" title="class in &lt;Unnamed&gt;">AudioBook</a>&gt;&nbsp;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 &lt;Unnamed&gt;">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&nbsp;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&nbsp;scan,
java.util.ArrayList&lt;<a href="Album.html" title="class in &lt;Unnamed&gt;">Album</a>&gt;&nbsp;albums,
- java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;songs)</code>&nbsp;</td>
+ java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;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&lt;<a href="Album.html" title="class in &lt;Unnamed&gt;">Album</a>&gt;&nbsp;albums)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#contentOfAlbum-java.util.ArrayList-">contentOfAlbum</a></span>(java.util.ArrayList&lt;<a href="Album.html" title="class in &lt;Unnamed&gt;">Album</a>&gt;&nbsp;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&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;playlists)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#contentOfPlaylist-java.util.ArrayList-">contentOfPlaylist</a></span>(java.util.ArrayList&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;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&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#delPlaylist-java.util.ArrayList-">delPlaylist</a></span>(java.util.ArrayList&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;playlists)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#delPlaylist-java.util.ArrayList-">delPlaylist</a></span>(java.util.ArrayList&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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[]&nbsp;args)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="jMusicHub.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;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&nbsp;filename,
java.util.ArrayList&nbsp;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&nbsp;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 &lt;Unnamed&gt;"><code>Song</code></a>,
+<a href="AudioBook.html" title="class in &lt;Unnamed&gt;"><code>AudioBook</code></a>,
+<a href="Album.html" title="class in &lt;Unnamed&gt;"><code>Album</code></a>,
+<a href="Playlist.html" title="class in &lt;Unnamed&gt;"><code>Playlist</code></a>,
+<a href="Genre.html" title="enum in &lt;Unnamed&gt;"><code>Genre</code></a>,
+<a href="Category.html" title="enum in &lt;Unnamed&gt;"><code>Category</code></a>,
+<a href="Language.html" title="enum in &lt;Unnamed&gt;"><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&nbsp;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&nbsp;addSong(java.util.Scanner&nbsp;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 &lt;Unnamed&gt;"><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&nbsp;<a href="AudioBook.html" title="class in &lt;Unnamed&gt;">AudioBook</a>&nbsp;addAudioBook(java.util.Scanner&nbsp;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 &lt;Unnamed&gt;"><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&nbsp;<a href="Album.html" title="class in &lt;Unnamed&gt;">Album</a>&nbsp;addAlbum(java.util.Scanner&nbsp;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 &lt;Unnamed&gt;"><code>Album</code></a></dd>
</dl>
</li>
</ul>
@@ -325,10 +371,18 @@ extends java.lang.Object</pre>
<pre>public static&nbsp;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&nbsp;addPlaylist(java.util.Scanner&nbsp;scan,
java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;songs,
java.util.ArrayList&lt;<a href="AudioBook.html" title="class in &lt;Unnamed&gt;">AudioBook</a>&gt;&nbsp;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 &lt;Unnamed&gt;"><code>Playlist</code></a></dd>
</dl>
</li>
</ul>
@@ -340,10 +394,8 @@ extends java.lang.Object</pre>
<h4>save</h4>
<pre>public static&nbsp;void&nbsp;save(java.lang.String&nbsp;filename,
java.util.ArrayList&nbsp;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&nbsp;void&nbsp;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&nbsp;void&nbsp;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&nbsp;void&nbsp;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&nbsp;void&nbsp;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&nbsp;void&nbsp;addSongToAlbum(java.util.Scanner&nbsp;scan,
java.util.ArrayList&lt;<a href="Album.html" title="class in &lt;Unnamed&gt;">Album</a>&gt;&nbsp;albums,
java.util.ArrayList&lt;<a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a>&gt;&nbsp;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&nbsp;java.util.ArrayList&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;delPlaylist(java.util.ArrayList&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;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&nbsp;void&nbsp;contentOfPlaylist(java.util.ArrayList&lt;<a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a>&gt;&nbsp;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&nbsp;void&nbsp;contentOfAlbum(java.util.ArrayList&lt;<a href="Album.html" title="class in &lt;Unnamed&gt;">Album</a>&gt;&nbsp;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&nbsp;void&nbsp;main(java.lang.String[]&nbsp;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>
diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html
index a883888..a492339 100644
--- a/javadoc/overview-tree.html
+++ b/javadoc/overview-tree.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>Class Hierarchy</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/package-frame.html b/javadoc/package-frame.html
index cb38865..7d6630e 100644
--- a/javadoc/package-frame.html
+++ b/javadoc/package-frame.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>&lt;Unnamed&gt;</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/package-summary.html b/javadoc/package-summary.html
index 8ce57fa..203b197 100644
--- a/javadoc/package-summary.html
+++ b/javadoc/package-summary.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 -->
<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>
@@ -84,7 +84,7 @@
<tr class="altColor">
<td class="colFirst"><a href="jMusicHub.html" title="class in &lt;Unnamed&gt;">jMusicHub</a></td>
<td class="colLast">
-<div class="block">The jMusicHub class is basically the app.</div>
+<div class="block">The jMusicHub class is our main component.</div>
</td>
</tr>
<tr class="rowColor">
@@ -95,12 +95,14 @@
</tr>
<tr class="altColor">
<td class="colFirst"><a href="Playlist.html" title="class in &lt;Unnamed&gt;">Playlist</a></td>
-<td class="colLast">&nbsp;</td>
+<td class="colLast">
+<div class="block">The Playlist class is used to create playlists containing songs and audiobooks.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="Song.html" title="class in &lt;Unnamed&gt;">Song</a></td>
<td class="colLast">
-<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>
</td>
</tr>
</tbody>
diff --git a/javadoc/package-tree.html b/javadoc/package-tree.html
index a2f09f5..1c9ff75 100644
--- a/javadoc/package-tree.html
+++ b/javadoc/package-tree.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> Class Hierarchy</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html
index d6a9101..447f7be 100644
--- a/javadoc/serialized-form.html
+++ b/javadoc/serialized-form.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>Serialized Form</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">