From 7c23f453d166d396451504e26fbb385afc0c4c13 Mon Sep 17 00:00:00 2001 From: Clyhtsuriva Date: Mon, 28 Dec 2020 17:31:33 +0100 Subject: Finishing javadoc --- javadoc/jMusicHub.html | 162 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 129 insertions(+), 33 deletions(-) (limited to 'javadoc/jMusicHub.html') 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 @@ - + jMusicHub @@ -108,8 +108,8 @@ var activeTableTab = "activeTableTab"; 
public class jMusicHub
 extends java.lang.Object
-
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.
Since:
2020-11-13
@@ -132,7 +132,9 @@ extends java.lang.Object Constructor and Description -jMusicHub()  +jMusicHub() +
Constructor method, it is calling every methods and contains the command prompt.
+ @@ -152,13 +154,13 @@ extends java.lang.Object static Album addAlbum(java.util.Scanner scan) -
addAlbum is used to add albums thanks to the "a" option
+
addAlbum is used to add albums thanks to the "a" option.
static AudioBook addAudioBook(java.util.Scanner scan) -
addAudioBook is used to add songs thanks to the "l" option
+
addAudioBook is used to add songs thanks to the "l" option.
@@ -166,32 +168,40 @@ extends java.lang.Object addPlaylist(java.util.Scanner scan, java.util.ArrayList<Song> songs, java.util.ArrayList<AudioBook> audiobooks) -
addPlaylist is used to add playlist thanks to the "p" option
+
addPlaylist is used to add playlist thanks to the "p" option.
static Song addSong(java.util.Scanner scan) -
addSong is used to add songs thanks to the "c" option
+
addSong is used to add songs thanks to the "c" option.
static void addSongToAlbum(java.util.Scanner scan, java.util.ArrayList<Album> albums, - java.util.ArrayList<Song> songs)  + java.util.ArrayList<Song> songs) +
addSongToAlbum is called by the "+" command in order to add a song to an album.
+ static void -contentOfAlbum(java.util.ArrayList<Album> albums)  +contentOfAlbum(java.util.ArrayList<Album> albums) +
contentOfAlbum is called by the "AC" command in order to display the content of a chosen album.
+ static void -contentOfPlaylist(java.util.ArrayList<Playlist> playlists)  +contentOfPlaylist(java.util.ArrayList<Playlist> playlists) +
contentOfPlaylist is called by the "PC" command in order to display the content of a chosen playlist.
+ static java.util.ArrayList<Playlist> -delPlaylist(java.util.ArrayList<Playlist> playlists)  +delPlaylist(java.util.ArrayList<Playlist> playlists) +
delPlaylist is called by the "-" command in order to delete a playlist.
+ static java.util.ArrayList @@ -201,15 +211,21 @@ extends java.lang.Object static void -listAlbumsByDate()  +listAlbumsByDate() +
listAlbumsByDate is called by the "AD" command in order to list the albums sorted by the date of release.
+ static void -listAlbumsByGenre()  +listAlbumsByGenre() +
listAlbumsByGenre is called by the "AG" command in order to list the albums sorted by the genre of their songs.
+ static void -listAudioBooksByAuthor()  +listAudioBooksByAuthor() +
listAudioBooksByAuthor is called by the "BA" command in order to list the audiobooks sorted by authors.
+ static void @@ -219,20 +235,21 @@ extends java.lang.Object static void -listPlaylistsByName()  +listPlaylistsByName() +
listPlaylistsByName is called when using the "PN" command in order to list the playlists sorted by their name.
+ static void -main(java.lang.String[] args)  +main(java.lang.String[] args) +
The main method is used to launch the app.
+ static void save(java.lang.String filename, java.util.ArrayList elements) -
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".
@@ -264,6 +281,17 @@ extends java.lang.Object

  • jMusicHub

    public jMusicHub()
    +
    Constructor method, it is calling every methods and contains the command prompt.
    +
    +
    See Also:
    +
    Song, +AudioBook, +Album, +Playlist, +Genre, +Category, +Language
    +
    • @@ -281,10 +309,16 @@ extends java.lang.Object

  • addSong

    public static Song addSong(java.util.Scanner scan)
    -
    addSong is used to add songs thanks to the "c" option
    +
    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.
    Parameters:
    -
    scan - Scanner Object
    +
    scan - Scanner
    +
    Returns:
    +
    newSong Song
    +
    See Also:
    +
    Song
    • @@ -295,10 +329,16 @@ extends java.lang.Object

  • addAudioBook

    public static AudioBook addAudioBook(java.util.Scanner scan)
    -
    addAudioBook is used to add songs thanks to the "l" option
    +
    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.
    Parameters:
    -
    scan - Scanner Object
    +
    scan - Scanner
    +
    Returns:
    +
    newAudioBook AudioBook
    +
    See Also:
    +
    AudioBook
    • @@ -309,10 +349,16 @@ extends java.lang.Object

  • addAlbum

    public static Album addAlbum(java.util.Scanner scan)
    -
    addAlbum is used to add albums thanks to the "a" option
    +
    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.
    Parameters:
    -
    scan - Scanner Object
    +
    scan - Scanner
    +
    Returns:
    +
    newAlbum Album
    +
    See Also:
    +
    Album
    • @@ -325,10 +371,18 @@ extends java.lang.Object 
    public static Playlist addPlaylist(java.util.Scanner scan,
                                    java.util.ArrayList<Song> songs,
                                    java.util.ArrayList<AudioBook> audiobooks)
    -
    addPlaylist is used to add playlist thanks to the "p" option
    +
    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.
    Parameters:
    -
    scan - Scanner Object
    +
    scan - Scanner
    +
    songs - ArrayList
    +
    audiobooks - ArrayList
    +
    Returns:
    +
    newPlaylist Playlist
    +
    See Also:
    +
    Playlist
    @@ -340,10 +394,8 @@ extends java.lang.Object

    save

    public static void save(java.lang.String filename,
                         java.util.ArrayList elements)
    -
    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.
    Parameters:
    filename - String
    @@ -372,6 +424,12 @@ extends java.lang.Object

  • listPlaylistsByName

    public static void listPlaylistsByName()
    +
    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 Also:
    +
    Playlist.getName()
    +
    • @@ -381,6 +439,7 @@ extends java.lang.Object

  • listAlbumsByDate

    public static void listAlbumsByDate()
    +
    listAlbumsByDate is called by the "AD" command in order to list the albums sorted by the date of release.
    •  @@ -390,6 +449,11 @@ extends java.lang.Object

  • listAlbumsByGenre

    public static void listAlbumsByGenre()
    +
    listAlbumsByGenre is called by the "AG" command in order to list the albums sorted by the genre of their songs.
    +
    +
    See Also:
    +
    Album.getGenre()
    +
    • @@ -399,6 +463,7 @@ extends java.lang.Object

  • listAudioBooksByAuthor

    public static void listAudioBooksByAuthor()
    +
    listAudioBooksByAuthor is called by the "BA" command in order to list the audiobooks sorted by authors.
    •  @@ -412,6 +477,8 @@ extends java.lang.Object
    Parameters:
    filename - String
    +
    Returns:
    +
    ArrayList
    @@ -424,6 +491,13 @@ extends java.lang.Object 
    public static void addSongToAlbum(java.util.Scanner scan,
                                   java.util.ArrayList<Album> albums,
                                   java.util.ArrayList<Song> songs)
    +
    addSongToAlbum is called by the "+" command in order to add a song to an album.
    +
    +
    Parameters:
    +
    scan - Scanner
    +
    albums - ArrayList
    +
    songs - ArrayList
    +
    @@ -433,6 +507,13 @@ extends java.lang.Object

  • delPlaylist

    public static java.util.ArrayList<Playlist> delPlaylist(java.util.ArrayList<Playlist> playlists)
    +
    delPlaylist is called by the "-" command in order to delete a playlist.
    +
    +
    Parameters:
    +
    playlists - ArrayList
    +
    Returns:
    +
    playlists ArrayList
    +
    • @@ -442,6 +523,11 @@ extends java.lang.Object

  • contentOfPlaylist

    public static void contentOfPlaylist(java.util.ArrayList<Playlist> playlists)
    +
    contentOfPlaylist is called by the "PC" command in order to display the content of a chosen playlist.
    +
    +
    Parameters:
    +
    playlists - ArrayList
    +
    • @@ -451,6 +537,11 @@ extends java.lang.Object

  • contentOfAlbum

    public static void contentOfAlbum(java.util.ArrayList<Album> albums)
    +
    contentOfAlbum is called by the "AC" command in order to display the content of a chosen album.
    +
    +
    Parameters:
    +
    albums - ArrayList
    +
    • @@ -460,6 +551,11 @@ extends java.lang.Object

  • main

    public static void main(java.lang.String[] args)
    +
    The main method is used to launch the app.
    +
    +
    Parameters:
    +
    args - String[]
    +
    • -- cgit v1.2.3