From 7c23f453d166d396451504e26fbb385afc0c4c13 Mon Sep 17 00:00:00 2001 From: Clyhtsuriva Date: Mon, 28 Dec 2020 17:31:33 +0100 Subject: Finishing javadoc --- javadoc/Playlist.html | 75 ++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 65 insertions(+), 10 deletions(-) (limited to 'javadoc/Playlist.html') 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 @@ - + Playlist @@ -113,9 +113,12 @@ var activeTableTab = "activeTableTab"; 
public class Playlist
 extends java.lang.Object
 implements java.io.Serializable
+
The Playlist class is used to create playlists containing songs and audiobooks.
See Also:
-
Serialized Form
+
Song, +AudioBook, +Serialized Form
@@ -137,7 +140,9 @@ implements java.io.Serializable Playlist(java.lang.String name, java.util.ArrayList<Song> songs, - java.util.ArrayList<AudioBook> audiobooks)  + java.util.ArrayList<AudioBook> audiobooks) +
Constructor method.
+ @@ -156,31 +161,45 @@ implements java.io.Serializable void -getAudioBooks()  +getAudioBooks() +
This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.
+ int -getId()  +getId() +
This method is used to give the id of the playlist.
+ java.lang.String -getName()  +getName() +
This method is used to give the name of the playlist in uppercase.
+ void -getSongs()  +getSongs() +
This method is used to print the each songs contained in the songs attribute of the playlist.
+ void -setId(int id)  +setId(int id) +
Basic method to set the id of the playlist.
+ void -setName(java.lang.String name)  +setName(java.lang.String name) +
Basic method to set the name of the playlist.
+ java.lang.String -toString()  +toString() +
Basic method to "configure" what does a print of this object actually does.
+ @@ -230,6 +259,11 @@ implements java.io.Serializable

  • getId

    public int getId()
    +
    This method is used to give the id of the playlist.
    +
    +
    Returns:
    +
    id int
    +
    • @@ -239,6 +273,12 @@ implements java.io.Serializable

  • getName

    public java.lang.String getName()
    +
    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.
    +
    +
    Returns:
    +
    name.toUpperCase String
    +
    •  @@ -248,6 +288,7 @@ implements java.io.Serializable

  • getSongs

    public void getSongs()
    +
    This method is used to print the each songs contained in the songs attribute of the playlist.
    •  @@ -257,6 +298,7 @@ implements java.io.Serializable

  • getAudioBooks

    public void getAudioBooks()
    +
    This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.
    •  @@ -266,6 +308,11 @@ implements java.io.Serializable

  • setId

    public void setId(int id)
    +
    Basic method to set the id of the playlist.
    +
    +
    Parameters:
    +
    id - int
    +
    •  @@ -275,6 +322,11 @@ implements java.io.Serializable

  • setName

    public void setName(java.lang.String name)
    +
    Basic method to set the name of the playlist.
    +
    +
    Parameters:
    +
    name - String
    +
    •  @@ -284,9 +336,12 @@ implements java.io.Serializable

  • toString

    public java.lang.String toString()
    +
    Basic method to "configure" what does a print of this object actually does.
    Overrides:
    toString in class java.lang.Object
    +
    Returns:
    +
    String, using the object's methods
    • -- cgit v1.2.3