Album

java.lang.Object
+
- 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 Type	Method and Description
`void`	`addSong(Song song)` + Mehtod to add songs, of the Song class, to the album's arrayList. +
`java.lang.String`	`getArtist()` + This method is used to give the artist of the album. +
`java.util.Date`	`getDate()` + This method is used to give the date of release of the album. +
`int`	`getDuration()` + This method is used to give the duration of the album. +
`java.lang.String`	`getGenre()` + This method is used for the AG command in jMusicHub. +
`int`	`getId()` + This method is used to give the id of the album. +
`void`	`getSongs()`
`java.lang.String`	`getTitle()` + This method is used to give the title of the album. +
`void`	`setArtist(java.lang.String artist)` + Basic method to set the artist of the album. +
`void`	`setDate(java.util.Date date)` + Basic method to set the date of the album. +
`void`	`setId(int id)` + Basic method to set the id of the album. +
`void`	`setTitle(java.lang.String title)` + Basic method to set the title of the album. +
`java.lang.String`	`toString()` + 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
    +
    +
  +
+

java.lang.Object
+
- MusicalElement
- +
  - AudioBook
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable
+
+
+
+
```
public class AudioBook
+extends MusicalElement
```
+
The AudioBook class is used to create audiobooks while extending MusicalElement.
+
+
See Also:
+
MusicalElement, +Serialized Form
+
+

+ +

+ + +

Constructor Summary

+ + + + + + + + +

Constructors
Constructor and Description
`AudioBook(java.lang.String title, + int duration, + java.lang.String content, + java.lang.String author, + Language language, + Category category)` + Constructor method. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthor()` + This method is used to give the author of the audiobook. +
`java.lang.String`	`getCategory()` + This method is used to give the category of the audiobook. +
`java.lang.String`	`getLanguage()` + This method is used to give the language of the audiobook. +
`void`	`setArtist(java.lang.String author)` + Basic method to set the author of audiobook. +
`void`	`setCategory(Category category)` + Basic method to set the category of the audiobook using the name method from the Category class. +
`void`	`setGenre(Language language)` + Basic method to set the language of the audiobook using the name method from the Language object. +
`java.lang.String`	`toString()` + Basic method to "configure" what does a print of this object actually does. +

+ + +
Methods inherited from class MusicalElement
+getContent, getDuration, getId, getTitle, setContent, setDuration, setId, setTitle

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    AudioBook
    +
```
public AudioBook(java.lang.String title,
+                 int duration,
+                 java.lang.String content,
+                 java.lang.String author,
+                 Language language,
+                 Category category)
```
    +
    Constructor method.
    +
    +
    Parameters:
    +
    title - String
    +
    duration - int
    +
    content - String, path to the mp3 file
    +
    author - String
    +
    language - Language
    +
    category - Category
    +
    See Also:
    +
    Language, +Category
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getAuthor
    +
```
public java.lang.String getAuthor()
```
    +
    This method is used to give the author of the audiobook.
    +
    +
    Returns:
    +
    It returns the author, which is a String
    +
    +
  + + + +
  - +
    getLanguage
    +
```
public java.lang.String getLanguage()
```
    +
    This method is used to give the language of the audiobook.
    +
    +
    Returns:
    +
    It returns the language, which is a String because the constructor use the name method of the Language object.
    +
    See Also:
    +
    Language
    +
    +
  + + + +
  - +
    getCategory
    +
```
public java.lang.String getCategory()
```
    +
    This method is used to give the category of the audiobook.
    +
    +
    Returns:
    +
    It returns the category, which is a String because the constructor use the name method of the Category object.
    +
    See Also:
    +
    Category
    +
    +
  + + + +
  - +
    setArtist
    +
```
public void setArtist(java.lang.String author)
```
    +
    Basic method to set the author of audiobook.
    +
    +
    Parameters:
    +
    author - String
    +
    +
  + + + +
  - +
    setGenre
    +
```
public void setGenre(Language language)
```
    +
    Basic method to set the language of the audiobook using the name method from the Language object.
    +
    +
    Parameters:
    +
    language - Language
    +
    See Also:
    +
    Language
    +
    +
  + + + +
  - +
    setCategory
    +
```
public void setCategory(Category category)
```
    +
    Basic method to set the category of the audiobook using the name method from the Category class.
    +
    +
    Parameters:
    +
    category - Category
    +
    +
  + + + +
  - +
    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
    +
    +
  +
+

java.lang.Object
+
- java.lang.Enum<Category>
- +
  - Category
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable, java.lang.Comparable<Category>
+
+
+
+
```
public enum Category
+extends java.lang.Enum<Category>
```
+
The Category enum is used by audiobooks as an attribute.
+
+
See Also:
+
AudioBook
+
+

+ +

+ + +
Enum Constant Summary
+ + + + + + + + + + + + + + + + + + + + +
Enum Constants
Enum Constant and Description
DOCUMENTARY
NOVEL
SPEECH
TEEN
THEATER
+

Enum Constants
Enum Constant and Description
`DOCUMENTARY`
`NOVEL`
`SPEECH`
`TEEN`
`THEATER`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Category`	`valueOf(java.lang.String name)` + Returns the enum constant of this type with the specified name. +
`static Category[]`	`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

+ + +
Methods inherited from class java.lang.Enum
+clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

+ + +
Methods inherited from class java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Enum Constant Detail
  + + + +
  - +
    TEEN
    +
```
public static final Category TEEN
```
    +
  + + + +
  - +
    NOVEL
    +
```
public static final Category NOVEL
```
    +
  + + + +
  - +
    THEATER
    +
```
public static final Category THEATER
```
    +
  + + + +
  - +
    SPEECH
    +
```
public static final Category SPEECH
```
    +
  + + + +
  - +
    DOCUMENTARY
    +
```
public static final Category DOCUMENTARY
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    values
    +
```
public static Category[] values()
```
    +
    Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
```
+for (Category c : Category.values())
+    System.out.println(c);
+
```
    +
    +
    Returns:
    +
    an array containing the constants of this enum type, in the order they are declared
    +
    +
  + + + +
  - +
    valueOf
    +
```
public static Category valueOf(java.lang.String name)
```
    +
    Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
    +
    +
    Parameters:
    +
    name - the name of the enum constant to be returned.
    +
    Returns:
    +
    the enum constant with the specified name
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    +
    java.lang.NullPointerException - if the argument is null
    +
    +
  +
+

java.lang.Object
+
- java.lang.Enum<Genre>
- +
  - Genre
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable, java.lang.Comparable<Genre>
+
+
+
+
```
public enum Genre
+extends java.lang.Enum<Genre>
```
+
The Genre enum is used by songs as an attribute.
+
+
See Also:
+
Song
+
+

+ +

+ + +
Enum Constant Summary
+ + + + + + + + + + + + + + + + + + + + + + + +
Enum Constants
Enum Constant and Description
CLASSICAL
HIPHOP
JAZZ
POP
RAP
ROCK
+

Enum Constants
Enum Constant and Description
`CLASSICAL`
`HIPHOP`
`JAZZ`
`POP`
`RAP`
`ROCK`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Genre`	`valueOf(java.lang.String name)` + Returns the enum constant of this type with the specified name. +
`static Genre[]`	`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

+ + +
Methods inherited from class java.lang.Enum
+clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

+ + +
Methods inherited from class java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Enum Constant Detail
  + + + +
  - +
    JAZZ
    +
```
public static final Genre JAZZ
```
    +
  + + + +
  - +
    CLASSICAL
    +
```
public static final Genre CLASSICAL
```
    +
  + + + +
  - +
    HIPHOP
    +
```
public static final Genre HIPHOP
```
    +
  + + + +
  - +
    ROCK
    +
```
public static final Genre ROCK
```
    +
  + + + +
  - +
    POP
    +
```
public static final Genre POP
```
    +
  + + + +
  - +
    RAP
    +
```
public static final Genre RAP
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    values
    +
```
public static Genre[] values()
```
    +
    Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
```
+for (Genre c : Genre.values())
+    System.out.println(c);
+
```
    +
    +
    Returns:
    +
    an array containing the constants of this enum type, in the order they are declared
    +
    +
  + + + +
  - +
    valueOf
    +
```
public static Genre valueOf(java.lang.String name)
```
    +
    Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
    +
    +
    Parameters:
    +
    name - the name of the enum constant to be returned.
    +
    Returns:
    +
    the enum constant with the specified name
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    +
    java.lang.NullPointerException - if the argument is null
    +
    +
  +
+

java.lang.Object
+
- java.lang.Enum<Language>
- +
  - Language
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable, java.lang.Comparable<Language>
+
+
+
+
```
public enum Language
+extends java.lang.Enum<Language>
```
+
The Language enum is used by audiobooks as an attribute.
+
+
See Also:
+
AudioBook
+
+

+ +

+ + +
Enum Constant Summary
+ + + + + + + + + + + + + + + + + + + + +
Enum Constants
Enum Constant and Description
ENGLISH
FRENCH
GERMAN
ITALIAN
SPANISH
+

Enum Constants
Enum Constant and Description
`ENGLISH`
`FRENCH`
`GERMAN`
`ITALIAN`
`SPANISH`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Language`	`valueOf(java.lang.String name)` + Returns the enum constant of this type with the specified name. +
`static Language[]`	`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

+ + +
Methods inherited from class java.lang.Enum
+clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

+ + +
Methods inherited from class java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Enum Constant Detail
  + + + +
  - +
    FRENCH
    +
```
public static final Language FRENCH
```
    +
  + + + +
  - +
    ENGLISH
    +
```
public static final Language ENGLISH
```
    +
  + + + +
  - +
    ITALIAN
    +
```
public static final Language ITALIAN
```
    +
  + + + +
  - +
    SPANISH
    +
```
public static final Language SPANISH
```
    +
  + + + +
  - +
    GERMAN
    +
```
public static final Language GERMAN
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    values
    +
```
public static Language[] values()
```
    +
    Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
```
+for (Language c : Language.values())
+    System.out.println(c);
+
```
    +
    +
    Returns:
    +
    an array containing the constants of this enum type, in the order they are declared
    +
    +
  + + + +
  - +
    valueOf
    +
```
public static Language valueOf(java.lang.String name)
```
    +
    Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
    +
    +
    Parameters:
    +
    name - the name of the enum constant to be returned.
    +
    Returns:
    +
    the enum constant with the specified name
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    +
    java.lang.NullPointerException - if the argument is null
    +
    +
  +
+

java.lang.Object
+
- MusicalElement
+

+
+
All Implemented Interfaces:
+
java.io.Serializable
+
+
+
Direct Known Subclasses:
+
AudioBook, Song
+
+
+
+
```
public abstract class MusicalElement
+extends java.lang.Object
+implements java.io.Serializable
```
+
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.
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
MusicalElement(java.lang.String title, + int duration, + java.lang.String content)
+

Constructors
Constructor and Description
`MusicalElement(java.lang.String title, + int duration, + java.lang.String content)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getContent()`
`int`	`getDuration()`
`int`	`getId()`
`java.lang.String`	`getTitle()`
`void`	`setContent(java.lang.String content)`
`void`	`setDuration(int duration)`
`void`	`setId(int id)`
`void`	`setTitle(java.lang.String title)`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +

Constructor Detail

+ + + +

MusicalElement

public MusicalElement(java.lang.String title,
+                      int duration,
+                      java.lang.String content)

+ +

+ + +

Method Detail

+ + + +

+
getId
+
```
public int getId()
```
+

+ + + +

+
getTitle
+
```
public java.lang.String getTitle()
```
+

+ + + +

+
getDuration
+
```
public int getDuration()
```
+

+ + + +

+
getContent
+
```
public java.lang.String getContent()
```
+

+ + + +

+
setId
+
```
public void setId(int id)
```
+

+ + + +

setTitle

public void setTitle(java.lang.String title)

+ + + +

setDuration

public void setDuration(int duration)

+ + + +

setContent

public void setContent(java.lang.String content)

java.lang.Object
+
- Playlist
+

+
+
All Implemented Interfaces:
+
java.io.Serializable
+
+
+
+
```
public class Playlist
+extends java.lang.Object
+implements java.io.Serializable
```
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
Playlist(java.lang.String name, + java.util.ArrayList<Song> songs, + java.util.ArrayList<AudioBook> audiobooks)
+

Constructors
Constructor and Description
`Playlist(java.lang.String name, + java.util.ArrayList<Song> songs, + java.util.ArrayList<AudioBook> audiobooks)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`getAudioBooks()`
`int`	`getId()`
`java.lang.String`	`getName()`
`void`	`getSongs()`
`void`	`setId(int id)`
`void`	`setName(java.lang.String name)`
`java.lang.String`	`toString()`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

+ +

+ + +

Constructor Detail

+ + + +

Playlist

public Playlist(java.lang.String name,
+                java.util.ArrayList<Song> songs,
+                java.util.ArrayList<AudioBook> audiobooks)

+ +

+ + +

Method Detail

+ + + +

+
getId
+
```
public int getId()
```
+

+ + + +

+
getName
+
```
public java.lang.String getName()
```
+

+ + + +

+
getSongs
+
```
public void getSongs()
```
+

+ + + +

+
getAudioBooks
+
```
public void getAudioBooks()
```
+

+ + + +

+
setId
+
```
public void setId(int id)
```
+

+ + + +

setName

public void setName(java.lang.String name)

+ + + +

+
toString
+
```
public java.lang.String toString()
```
+
+
Overrides:
+
toString in class java.lang.Object
+
+

java.lang.Object
+
- MusicalElement
- +
  - Song
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable
+
+
+
+
```
public class Song
+extends MusicalElement
```
+
Song is using instanciating MusicalElement and is Serializable.
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
Song(java.lang.String title, + int duration, + java.lang.String content, + java.lang.String artist, + Genre genre)
+

Constructors
Constructor and Description
`Song(java.lang.String title, + int duration, + java.lang.String content, + java.lang.String artist, + Genre genre)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getArtist()`
`java.lang.String`	`getGenre()`
`void`	`setArtist(java.lang.String artist)`
`void`	`setGenre(Genre genre)`
`java.lang.String`	`toString()`

+ + +
Methods inherited from class MusicalElement
+getContent, getDuration, getId, getTitle, setContent, setDuration, setId, setTitle

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

+ +

+ + +

Constructor Detail

+ + + +

Song

public Song(java.lang.String title,
+            int duration,
+            java.lang.String content,
+            java.lang.String artist,
+            Genre genre)

+ +

+ + +

Method Detail

+ + + +

+
getArtist
+
```
public java.lang.String getArtist()
```
+

+ + + +

+
getGenre
+
```
public java.lang.String getGenre()
```
+

+ + + +

setArtist

public void setArtist(java.lang.String artist)

+ + + +

+
setGenre
+
```
public void setGenre(Genre genre)
```
+

+ + + +

+
toString
+
```
public java.lang.String toString()
```
+
+
Overrides:
+
toString in class java.lang.Object
+
+

All Classes

+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
+
+
Class/Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description
+
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary
+
- Field Detail
- Constructor Detail
- Method Detail
+
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
Annotation Type
+
Each annotation type has its own separate page with the following sections:
+
- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
+
+
Enum
+
Each enum has its own separate page with the following sections:
+
- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
Index
+
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
Prev/Next
+
These links take you to the next or previous class, interface, package, or related page.
+
+
Frames/No Frames
+
These links show and hide the HTML frames. All pages are available with or without frames.
+
+
All Classes
+
The All Classes link shows all classes and interfaces except non-static nested types.
+
+
Serialized Form
+
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+
+
Constant Field Values
+
The Constant Field Values page lists the static final fields and their values.
+

+This help file applies to API documentation generated using the standard doclet.

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

java.lang.Object
+
- jMusicHub
+

+
+
+
```
public class jMusicHub
+extends java.lang.Object
```
+
The jMusicHub class is basically the app. + It is used to launch the whole process.
+
+
Since:
+
2020-11-13
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
jMusicHub()
+

Constructors
Constructor and Description
`jMusicHub()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Album`	`addAlbum(java.util.Scanner scan)` + 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 +
`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 +
`static Song`	`addSong(java.util.Scanner scan)` + 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)`
`static void`	`contentOfAlbum(java.util.ArrayList<Album> albums)`
`static void`	`contentOfPlaylist(java.util.ArrayList<Playlist> playlists)`
`static java.util.ArrayList<Playlist>`	`delPlaylist(java.util.ArrayList<Playlist> playlists)`
`static java.util.ArrayList`	`extract(java.lang.String filename)` + Extract is used to print the content of the files and put them in the ArrayList used to add elements. +
`static void`	`listAlbumsByDate()`
`static void`	`listAlbumsByGenre()`
`static void`	`listAudioBooksByAuthor()`
`static void`	`listById(java.lang.String filename)` + list is called when using the "AB", "S", "A" and "P" commands in order to list the elements in respective files. +
`static void`	`listPlaylistsByName()`
`static void`	`main(java.lang.String[] args)`
`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. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    jMusicHub
    +
```
public jMusicHub()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    addSong
    +
```
public static Song addSong(java.util.Scanner scan)
```
    +
    addSong is used to add songs thanks to the "c" option
    +
    +
    Parameters:
    +
    scan - Scanner Object
    +
    +
  + + + +
  - +
    addAudioBook
    +
```
public static AudioBook addAudioBook(java.util.Scanner scan)
```
    +
    addAudioBook is used to add songs thanks to the "l" option
    +
    +
    Parameters:
    +
    scan - Scanner Object
    +
    +
  + + + +
  - +
    addAlbum
    +
```
public static Album addAlbum(java.util.Scanner scan)
```
    +
    addAlbum is used to add albums thanks to the "a" option
    +
    +
    Parameters:
    +
    scan - Scanner Object
    +
    +
  + + + +
  - +
    addPlaylist
    +
```
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
    +
    +
    Parameters:
    +
    scan - Scanner 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.
    +
    +
    Parameters:
    +
    filename - String
    +
    elements - ArrayList
    +
    +
  + + + +
  - +
    listById
    +
```
public static void listById(java.lang.String filename)
```
    +
    list is called when using the "AB", "S", "A" and "P" commands in order to list the elements in respective files.
    +
    +
    Parameters:
    +
    filename - String
    +
    +
  + + + +
  - +
    listPlaylistsByName
    +
```
public static void listPlaylistsByName()
```
    +
  + + + +
  - +
    listAlbumsByDate
    +
```
public static void listAlbumsByDate()
```
    +
  + + + +
  - +
    listAlbumsByGenre
    +
```
public static void listAlbumsByGenre()
```
    +
  + + + +
  - +
    listAudioBooksByAuthor
    +
```
public static void listAudioBooksByAuthor()
```
    +
  + + + +
  - +
    extract
    +
```
public static java.util.ArrayList extract(java.lang.String filename)
```
    +
    Extract is used to print the content of the files and put them in the ArrayList used to add elements.
    +
    +
    Parameters:
    +
    filename - String
    +
    +
  + + + +
  - +
    addSongToAlbum
    +
```
public static void addSongToAlbum(java.util.Scanner scan,
+                                  java.util.ArrayList<Album> albums,
+                                  java.util.ArrayList<Song> songs)
```
    +
  + + + +
  - +
    delPlaylist
    +
```
public static java.util.ArrayList<Playlist> delPlaylist(java.util.ArrayList<Playlist> playlists)
```
    +
  + + + +
  - +
    contentOfPlaylist
    +
```
public static void contentOfPlaylist(java.util.ArrayList<Playlist> playlists)
```
    +
  + + + +
  - +
    contentOfAlbum
    +
```
public static void contentOfAlbum(java.util.ArrayList<Album> albums)
```
    +
  + + + +
  - +
    main
    +
```
public static void main(java.lang.String[] args)
```
    +
  +
+

Class Hierarchy

java.lang.Object +
- Album (implements java.io.Serializable)
- jMusicHub
- MusicalElement (implements java.io.Serializable) +
  - AudioBook
  - Song
  +
- Playlist (implements java.io.Serializable)
+

Enum Hierarchy

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
  - Category
  - Genre
  - Language
  +
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Class Summary
Class	Description
Album	+ The album class is used to create albums containing songs added after its creation and the creation of the songs. +
AudioBook	+ The AudioBook class is used to create audiobooks while extending MusicalElement. +
jMusicHub	+ The jMusicHub class is basically the app. +
MusicalElement	+ The MusicalElement contains the base of songs and audiobooks. +
Playlist
Song	+ Song is using instanciating MusicalElement and is Serializable. +

+ + + + + + + + + + + + + + + + + + + + +

Enum Summary
Enum	Description
Category	+ The Category enum is used by audiobooks as an attribute. +
Genre	+ The Genre enum is used by songs as an attribute. +
Language	+ The Language enum is used by audiobooks as an attribute. +

Class Hierarchy

java.lang.Object +
- Album (implements java.io.Serializable)
- jMusicHub
- MusicalElement (implements java.io.Serializable) +
  - AudioBook
  - Song
  +
- Playlist (implements java.io.Serializable)
+

Enum Hierarchy

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
  - Category
  - Genre
  - Language
  +
+

+
Package <Unnamed>
+
- + + +
  Class Album extends java.lang.Object implements Serializable
  +
  +
  serialVersionUID:
  +
  -8678385322105507976L
  +
  +
  - +
    Serialized Fields
    +
    - +
      id
      +
```
int id
```
      +
    - +
      duration
      +
```
int duration
```
      +
    - +
      date
      +
```
java.util.Date date
```
      +
    - +
      title
      +
```
java.lang.String title
```
      +
    - +
      artist
      +
```
java.lang.String artist
```
      +
    - +
      songs
      +
```
java.util.ArrayList<E> songs
```
      +
    +
  +
- + + +
  Class AudioBook extends MusicalElement implements Serializable
  +
  +
  serialVersionUID:
  +
  -7145972304319088676L
  +
  +
  - +
    Serialized Fields
    +
    - +
      author
      +
```
java.lang.String author
```
      +
    - +
      language
      +
```
java.lang.String language
```
      +
    - +
      category
      +
```
java.lang.String category
```
      +
    +
  +
- + + +
  Class MusicalElement extends java.lang.Object implements Serializable
  +
  - +
    Serialized Fields
    +
    - +
      id
      +
```
int id
```
      +
    - +
      duration
      +
```
int duration
```
      +
    - +
      title
      +
```
java.lang.String title
```
      +
    - +
      content
      +
```
java.lang.String content
```
      +
    +
  +
- + + +
  Class Playlist extends java.lang.Object implements Serializable
  +
  +
  serialVersionUID:
  +
  6021717365357635741L
  +
  +
  - +
    Serialized Fields
    +
    - +
      id
      +
```
int id
```
      +
    - +
      name
      +
```
java.lang.String name
```
      +
    - +
      songs
      +
```
java.util.ArrayList<E> songs
```
      +
    - +
      audiobooks
      +
```
java.util.ArrayList<E> audiobooks
```
      +
    +
  +
- + + +
  Class Song extends MusicalElement implements Serializable
  +
  +
  serialVersionUID:
  +
  2112880640160601826L
  +
  +
  - +
    Serialized Fields
    +
    - +
      artist
      +
```
java.lang.String artist
```
      +
    - +
      genre
      +
```
java.lang.String genre
```
      +
    +
  +
+

Song

+/** * Song is using instanciating MusicalElement and is Serializable. * */ diff --git a/jMusicHub.java b/jMusicHub.java index e79d768..363695e 100644 --- a/jMusicHub.java +++ b/jMusicHub.java @@ -2,8 +2,7 @@ import java.util.*; import java.io.*; import java.text.*; -/**

jMusicHub

addSong

addAudioBook

addAlbum

addPlaylist

save

listById

extract

Class Album

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Album

Method Detail

getId

getTitle

getDuration

getArtist

getDate

getSongs

getGenre

setId

setTitle

setArtist

setDate

addSong

toString

Class AudioBook

Constructor Summary

Method Summary

Methods inherited from class MusicalElement

Methods inherited from class java.lang.Object

Constructor Detail

AudioBook

Method Detail

getAuthor

getLanguage

getCategory

setArtist

setGenre

setCategory

toString

Enum Category

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TEEN

NOVEL

THEATER

SPEECH

DOCUMENTARY

Method Detail

values

valueOf

Enum Genre

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

JAZZ

CLASSICAL

HIPHOP

ROCK

POP

RAP

Method Detail

values

valueOf

Enum Language

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

+/** * Song is using instanciating MusicalElement and is Serializable. * / diff --git a/jMusicHub.java b/jMusicHub.java index e79d768..363695e 100644 --- a/jMusicHub.java +++ b/jMusicHub.java @@ -2,8 +2,7 @@ import java.util.; import java.io.; import java.text.; -/**