From de39259ada4f75ac987f9bd8f0674ebede75a0de Mon Sep 17 00:00:00 2001 From: Clyhtsuriva Date: Mon, 28 Dec 2020 16:09:37 +0100 Subject: Starting javadoc --- javadoc/index-all.html | 433 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 433 insertions(+) create mode 100644 javadoc/index-all.html (limited to 'javadoc/index-all.html') diff --git a/javadoc/index-all.html b/javadoc/index-all.html new file mode 100644 index 0000000..9359c45 --- /dev/null +++ b/javadoc/index-all.html @@ -0,0 +1,433 @@ + + + + + +Index + + + + + + + + +
+ + + + + + + +
+ + +
A C D E G J L M P S T V  + + +

A

+
+
addAlbum(Scanner) - Static method in class jMusicHub
+
+
addAlbum is used to add albums thanks to the "a" option
+
+
addAudioBook(Scanner) - Static method in class jMusicHub
+
+
addAudioBook is used to add songs thanks to the "l" option
+
+
addPlaylist(Scanner, ArrayList<Song>, ArrayList<AudioBook>) - Static method in class jMusicHub
+
+
addPlaylist is used to add playlist thanks to the "p" option
+
+
addSong(Song) - Method in class Album
+
+
Mehtod to add songs, of the Song class, to the album's arrayList.
+
+
addSong(Scanner) - Static method in class jMusicHub
+
+
addSong is used to add songs thanks to the "c" option
+
+
addSongToAlbum(Scanner, ArrayList<Album>, ArrayList<Song>) - Static method in class jMusicHub
+
 
+
Album - Class in <Unnamed>
+
+
The album class is used to create albums containing songs added after its creation and the creation of the songs.
+
+
Album(String, int, String, Date, ArrayList<Song>) - Constructor for class Album
+
+
Constructor method.
+
+
AudioBook - Class in <Unnamed>
+
+
The AudioBook class is used to create audiobooks while extending MusicalElement.
+
+
AudioBook(String, int, String, String, Language, Category) - Constructor for class AudioBook
+
+
Constructor method.
+
+
+ + + +

C

+
+
Category - Enum in <Unnamed>
+
+
The Category enum is used by audiobooks as an attribute.
+
+
contentOfAlbum(ArrayList<Album>) - Static method in class jMusicHub
+
 
+
contentOfPlaylist(ArrayList<Playlist>) - Static method in class jMusicHub
+
 
+
+ + + +

D

+
+
delPlaylist(ArrayList<Playlist>) - Static method in class jMusicHub
+
 
+
+ + + +

E

+
+
extract(String) - Static method in class jMusicHub
+
+
Extract is used to print the content of the files and put them in the ArrayList used to add elements.
+
+
+ + + +

G

+
+
Genre - Enum in <Unnamed>
+
+
The Genre enum is used by songs as an attribute.
+
+
getArtist() - Method in class Album
+
+
This method is used to give the artist of the album.
+
+
getArtist() - Method in class Song
+
 
+
getAudioBooks() - Method in class Playlist
+
 
+
getAuthor() - Method in class AudioBook
+
+
This method is used to give the author of the audiobook.
+
+
getCategory() - Method in class AudioBook
+
+
This method is used to give the category of the audiobook.
+
+
getContent() - Method in class MusicalElement
+
 
+
getDate() - Method in class Album
+
+
This method is used to give the date of release of the album.
+
+
getDuration() - Method in class Album
+
+
This method is used to give the duration of the album.
+
+
getDuration() - Method in class MusicalElement
+
 
+
getGenre() - Method in class Album
+
+
This method is used for the AG command in jMusicHub.
+
+
getGenre() - Method in class Song
+
 
+
getId() - Method in class Album
+
+
This method is used to give the id of the album.
+
+
getId() - Method in class MusicalElement
+
 
+
getId() - Method in class Playlist
+
 
+
getLanguage() - Method in class AudioBook
+
+
This method is used to give the language of the audiobook.
+
+
getName() - Method in class Playlist
+
 
+
getSongs() - Method in class Album
+
 
+
getSongs() - Method in class Playlist
+
 
+
getTitle() - Method in class Album
+
+
This method is used to give the title of the album.
+
+
getTitle() - Method in class MusicalElement
+
 
+
+ + + +

J

+
+
jMusicHub - Class in <Unnamed>
+
+
The jMusicHub class is basically the app.
+
+
jMusicHub() - Constructor for class jMusicHub
+
 
+
+ + + +

L

+
+
Language - Enum in <Unnamed>
+
+
The Language enum is used by audiobooks as an attribute.
+
+
listAlbumsByDate() - Static method in class jMusicHub
+
 
+
listAlbumsByGenre() - Static method in class jMusicHub
+
 
+
listAudioBooksByAuthor() - Static method in class jMusicHub
+
 
+
listById(String) - Static method in class jMusicHub
+
+
list is called when using the "AB", "S", "A" and "P" commands in order to list the elements in respective files.
+
+
listPlaylistsByName() - Static method in class jMusicHub
+
 
+
+ + + +

M

+
+
main(String[]) - Static method in class jMusicHub
+
 
+
MusicalElement - Class in <Unnamed>
+
+
The MusicalElement contains the base of songs and audiobooks.
+
+
MusicalElement(String, int, String) - Constructor for class MusicalElement
+
 
+
+ + + +

P

+
+
Playlist - Class in <Unnamed>
+
 
+
Playlist(String, ArrayList<Song>, ArrayList<AudioBook>) - Constructor for class Playlist
+
 
+
+ + + +

S

+
+
save(String, ArrayList) - Static method in 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.
+
+
setArtist(String) - Method in class Album
+
+
Basic method to set the artist of the album.
+
+
setArtist(String) - Method in class AudioBook
+
+
Basic method to set the author of audiobook.
+
+
setArtist(String) - Method in class Song
+
 
+
setCategory(Category) - Method in class AudioBook
+
+
Basic method to set the category of the audiobook using the name method from the Category class.
+
+
setContent(String) - Method in class MusicalElement
+
 
+
setDate(Date) - Method in class Album
+
+
Basic method to set the date of the album.
+
+
setDuration(int) - Method in class MusicalElement
+
 
+
setGenre(Language) - Method in class AudioBook
+
+
Basic method to set the language of the audiobook using the name method from the Language object.
+
+
setGenre(Genre) - Method in class Song
+
 
+
setId(int) - Method in class Album
+
+
Basic method to set the id of the album.
+
+
setId(int) - Method in class MusicalElement
+
 
+
setId(int) - Method in class Playlist
+
 
+
setName(String) - Method in class Playlist
+
 
+
setTitle(String) - Method in class Album
+
+
Basic method to set the title of the album.
+
+
setTitle(String) - Method in class MusicalElement
+
 
+
Song - Class in <Unnamed>
+
+
Song is using instanciating MusicalElement and is Serializable.
+
+
Song(String, int, String, String, Genre) - Constructor for class Song
+
 
+
+ + + +

T

+
+
toString() - Method in class Album
+
+
Basic method to "configure" what does a print of this object actually does.
+
+
toString() - Method in class AudioBook
+
+
Basic method to "configure" what does a print of this object actually does.
+
+
toString() - Method in class Playlist
+
 
+
toString() - Method in class Song
+
 
+
+ + + +

V

+
+
valueOf(String) - Static method in enum Category
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum Genre
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum Language
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum Category
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum Genre
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum Language
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+A C D E G J L M P S T V 
+ +
+ + + + + + + +
+ + + + -- cgit v1.2.3