From de39259ada4f75ac987f9bd8f0674ebede75a0de Mon Sep 17 00:00:00 2001 From: Clyhtsuriva Date: Mon, 28 Dec 2020 16:09:37 +0100 Subject: Starting javadoc --- javadoc/Album.html | 546 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 546 insertions(+) create mode 100644 javadoc/Album.html (limited to 'javadoc/Album.html') diff --git a/javadoc/Album.html b/javadoc/Album.html new file mode 100644 index 0000000..6854986 --- /dev/null +++ b/javadoc/Album.html @@ -0,0 +1,546 @@ + + + + + +Album + + + + + + + + +
+ + + + + + + +
+ + + +
+

Class Album

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class Album
    +extends java.lang.Object
    +implements java.io.Serializable
    +
    The album class is used to create albums containing songs added after its creation and the creation of the songs.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Album(java.lang.String title, + int duration, + java.lang.String artist, + java.util.Date date, + java.util.ArrayList<Song> songs) +
      Constructor method.
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddSong(Song song) +
      Mehtod to add songs, of the Song class, to the album's arrayList.
      +
      java.lang.StringgetArtist() +
      This method is used to give the artist of the album.
      +
      java.util.DategetDate() +
      This method is used to give the date of release of the album.
      +
      intgetDuration() +
      This method is used to give the duration of the album.
      +
      java.lang.StringgetGenre() +
      This method is used for the AG command in jMusicHub.
      +
      intgetId() +
      This method is used to give the id of the album.
      +
      voidgetSongs() 
      java.lang.StringgetTitle() +
      This method is used to give the title of the album.
      +
      voidsetArtist(java.lang.String artist) +
      Basic method to set the artist of the album.
      +
      voidsetDate(java.util.Date date) +
      Basic method to set the date of the album.
      +
      voidsetId(int id) +
      Basic method to set the id of the album.
      +
      voidsetTitle(java.lang.String title) +
      Basic method to set the title of the album.
      +
      java.lang.StringtoString() +
      Basic method to "configure" what does a print of this object actually does.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Album

        +
        public Album(java.lang.String title,
        +             int duration,
        +             java.lang.String artist,
        +             java.util.Date date,
        +             java.util.ArrayList<Song> songs)
        +
        Constructor method.
        +
        +
        Parameters:
        +
        title - String
        +
        duration - int, calculated with the actual duration of the object's songs
        +
        artist - String
        +
        date - Date
        +
        songs - ArrayList
        +
        See Also:
        +
        MusicalElement
        +
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getId

        +
        public int getId()
        +
        This method is used to give the id of the album.
        +
        +
        Returns:
        +
        It returns the id, which is an int.
        +
        +
      • +
      + + + +
        +
      • +

        getTitle

        +
        public java.lang.String getTitle()
        +
        This method is used to give the title of the album.
        +
        +
        Returns:
        +
        It returns the title, which is a String.
        +
        +
      • +
      + + + +
        +
      • +

        getDuration

        +
        public int getDuration()
        +
        This method is used to give the duration of the album. + It calculates it by getting the duration of each songs.
        +
        +
        Returns:
        +
        It returns the total duration, which is an int.
        +
        See Also:
        +
        MusicalElement.getDuration()
        +
        +
      • +
      + + + +
        +
      • +

        getArtist

        +
        public java.lang.String getArtist()
        +
        This method is used to give the artist of the album.
        +
        +
        Returns:
        +
        It returns the artist, which is a String.
        +
        +
      • +
      + + + +
        +
      • +

        getDate

        +
        public java.util.Date getDate()
        +
        This method is used to give the date of release of the album.
        +
        +
        Returns:
        +
        It returns the date, which is a Date.
        +
        +
      • +
      + + + +
        +
      • +

        getSongs

        +
        public void getSongs()
        +
      • +
      + + + +
        +
      • +

        getGenre

        +
        public java.lang.String getGenre()
        +
        This method is used for the AG command in jMusicHub. + It's searching for the irst song in the ArrayList songs and takes it's name.
        +
        +
        Returns:
        +
        The genre, a Genre object, is returned.
        +
        See Also:
        +
        Song.getGenre(), +jMusicHub.listAlbumsByGenre()
        +
        +
      • +
      + + + +
        +
      • +

        setId

        +
        public void setId(int id)
        +
        Basic method to set the id of the album.
        +
        +
        Parameters:
        +
        id - int
        +
        +
      • +
      + + + +
        +
      • +

        setTitle

        +
        public void setTitle(java.lang.String title)
        +
        Basic method to set the title of the album.
        +
        +
        Parameters:
        +
        title - String
        +
        +
      • +
      + + + +
        +
      • +

        setArtist

        +
        public void setArtist(java.lang.String artist)
        +
        Basic method to set the artist of the album.
        +
        +
        Parameters:
        +
        artist - String
        +
        +
      • +
      + + + +
        +
      • +

        setDate

        +
        public void setDate(java.util.Date date)
        +
        Basic method to set the date of the album.
        +
        +
        Parameters:
        +
        date - Date
        +
        +
      • +
      + + + +
        +
      • +

        addSong

        +
        public void addSong(Song song)
        +
        Mehtod to add songs, of the Song class, to the album's arrayList.
        +
        +
        Parameters:
        +
        song - Song
        +
        +
      • +
      + + + +
        +
      • +

        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