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 ++++++++++++++++++++++++++++++++++++++ javadoc/AudioBook.html | 448 +++++++++++++++++++++++++++++++ javadoc/Category.html | 377 ++++++++++++++++++++++++++ javadoc/Genre.html | 389 +++++++++++++++++++++++++++ javadoc/Language.html | 377 ++++++++++++++++++++++++++ javadoc/MusicalElement.html | 379 ++++++++++++++++++++++++++ javadoc/Playlist.html | 361 +++++++++++++++++++++++++ javadoc/Song.html | 351 ++++++++++++++++++++++++ javadoc/allclasses-frame.html | 27 ++ javadoc/allclasses-noframe.html | 27 ++ javadoc/constant-values.html | 120 +++++++++ javadoc/deprecated-list.html | 120 +++++++++ javadoc/help-doc.html | 217 +++++++++++++++ javadoc/index-all.html | 433 ++++++++++++++++++++++++++++++ javadoc/index.html | 72 +++++ javadoc/jMusicHub.html | 533 +++++++++++++++++++++++++++++++++++++ javadoc/overview-tree.html | 151 +++++++++++ javadoc/package-frame.html | 31 +++ javadoc/package-list | 1 + javadoc/package-summary.html | 186 +++++++++++++ javadoc/package-tree.html | 151 +++++++++++ javadoc/script.js | 30 +++ javadoc/serialized-form.html | 280 ++++++++++++++++++++ javadoc/stylesheet.css | 574 ++++++++++++++++++++++++++++++++++++++++ 24 files changed, 6181 insertions(+) create mode 100644 javadoc/Album.html create mode 100644 javadoc/AudioBook.html create mode 100644 javadoc/Category.html create mode 100644 javadoc/Genre.html create mode 100644 javadoc/Language.html create mode 100644 javadoc/MusicalElement.html create mode 100644 javadoc/Playlist.html create mode 100644 javadoc/Song.html create mode 100644 javadoc/allclasses-frame.html create mode 100644 javadoc/allclasses-noframe.html create mode 100644 javadoc/constant-values.html create mode 100644 javadoc/deprecated-list.html create mode 100644 javadoc/help-doc.html create mode 100644 javadoc/index-all.html create mode 100644 javadoc/index.html create mode 100644 javadoc/jMusicHub.html create mode 100644 javadoc/overview-tree.html create mode 100644 javadoc/package-frame.html create mode 100644 javadoc/package-list create mode 100644 javadoc/package-summary.html create mode 100644 javadoc/package-tree.html create mode 100644 javadoc/script.js create mode 100644 javadoc/serialized-form.html create mode 100644 javadoc/stylesheet.css (limited to 'javadoc') 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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/AudioBook.html b/javadoc/AudioBook.html new file mode 100644 index 0000000..c8ba92e --- /dev/null +++ b/javadoc/AudioBook.html @@ -0,0 +1,448 @@ + + + + + +AudioBook + + + + + + + + +
+ + + + + + + +
+ + + +
+

Class 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 TypeMethod and Description
      java.lang.StringgetAuthor() +
      This method is used to give the author of the audiobook.
      +
      java.lang.StringgetCategory() +
      This method is used to give the category of the audiobook.
      +
      java.lang.StringgetLanguage() +
      This method is used to give the language of the audiobook.
      +
      voidsetArtist(java.lang.String author) +
      Basic method to set the author of audiobook.
      +
      voidsetCategory(Category category) +
      Basic method to set the category of the audiobook using the name method from the Category class.
      +
      voidsetGenre(Language language) +
      Basic method to set the language of the audiobook using the name method from the Language object.
      +
      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

      + + + +
        +
      • +

        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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/Category.html b/javadoc/Category.html new file mode 100644 index 0000000..6894769 --- /dev/null +++ b/javadoc/Category.html @@ -0,0 +1,377 @@ + + + + + +Category + + + + + + + + +
+ + + + + + + +
+ + + +
+

Enum 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
    +
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static CategoryvalueOf(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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/Genre.html b/javadoc/Genre.html new file mode 100644 index 0000000..f66b62a --- /dev/null +++ b/javadoc/Genre.html @@ -0,0 +1,389 @@ + + + + + +Genre + + + + + + + + +
+ + + + + + + +
+ + + +
+

Enum 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 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static GenrevalueOf(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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/Language.html b/javadoc/Language.html new file mode 100644 index 0000000..4f7f5e1 --- /dev/null +++ b/javadoc/Language.html @@ -0,0 +1,377 @@ + + + + + +Language + + + + + + + + +
+ + + + + + + +
+ + + +
+

Enum 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
    +
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static LanguagevalueOf(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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/MusicalElement.html b/javadoc/MusicalElement.html new file mode 100644 index 0000000..fa4e8c3 --- /dev/null +++ b/javadoc/MusicalElement.html @@ -0,0 +1,379 @@ + + + + + +MusicalElement + + + + + + + + +
+ + + + + + + +
+ + + +
+

Class 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) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetContent() 
      intgetDuration() 
      intgetId() 
      java.lang.StringgetTitle() 
      voidsetContent(java.lang.String content) 
      voidsetDuration(int duration) 
      voidsetId(int id) 
      voidsetTitle(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)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/Playlist.html b/javadoc/Playlist.html new file mode 100644 index 0000000..56c9b27 --- /dev/null +++ b/javadoc/Playlist.html @@ -0,0 +1,361 @@ + + + + + +Playlist + + + + + + + + +
+ + + + + + + +
+ + + +
+

Class 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) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidgetAudioBooks() 
      intgetId() 
      java.lang.StringgetName() 
      voidgetSongs() 
      voidsetId(int id) 
      voidsetName(java.lang.String name) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/Song.html b/javadoc/Song.html new file mode 100644 index 0000000..3f1712f --- /dev/null +++ b/javadoc/Song.html @@ -0,0 +1,351 @@ + + + + + +Song + + + + + + + + +
+ + + + + + + +
+ + + +
+

Class 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 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
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/allclasses-frame.html b/javadoc/allclasses-frame.html new file mode 100644 index 0000000..7b95261 --- /dev/null +++ b/javadoc/allclasses-frame.html @@ -0,0 +1,27 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html new file mode 100644 index 0000000..e1d75f1 --- /dev/null +++ b/javadoc/allclasses-noframe.html @@ -0,0 +1,27 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html new file mode 100644 index 0000000..9058d99 --- /dev/null +++ b/javadoc/constant-values.html @@ -0,0 +1,120 @@ + + + + + +Constant Field Values + + + + + + + + +
+ + + + + + + +
+ + +
+

Constant Field Values

+

Contents

+
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html new file mode 100644 index 0000000..2324e28 --- /dev/null +++ b/javadoc/deprecated-list.html @@ -0,0 +1,120 @@ + + + + + +Deprecated List + + + + + + + + +
+ + + + + + + +
+ + +
+

Deprecated API

+

Contents

+
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html new file mode 100644 index 0000000..7ee1fe6 --- /dev/null +++ b/javadoc/help-doc.html @@ -0,0 +1,217 @@ + + + + + +API Help + + + + + + + + +
+ + + + + + + +
+ + +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + + + + + + +
+ + + + 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 
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/index.html b/javadoc/index.html new file mode 100644 index 0000000..24dcdec --- /dev/null +++ b/javadoc/index.html @@ -0,0 +1,72 @@ + + + + + +Generated Documentation (Untitled) + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="Album.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/jMusicHub.html b/javadoc/jMusicHub.html new file mode 100644 index 0000000..46b3f16 --- /dev/null +++ b/javadoc/jMusicHub.html @@ -0,0 +1,533 @@ + + + + + +jMusicHub + + + + + + + + +
+ + + + + + + +
+ + + +
+

Class 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() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static AlbumaddAlbum(java.util.Scanner scan) +
      addAlbum is used to add albums thanks to the "a" option
      +
      static AudioBookaddAudioBook(java.util.Scanner scan) +
      addAudioBook is used to add songs thanks to the "l" option
      +
      static PlaylistaddPlaylist(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 SongaddSong(java.util.Scanner scan) +
      addSong is used to add songs thanks to the "c" option
      +
      static voidaddSongToAlbum(java.util.Scanner scan, + java.util.ArrayList<Album> albums, + java.util.ArrayList<Song> songs) 
      static voidcontentOfAlbum(java.util.ArrayList<Album> albums) 
      static voidcontentOfPlaylist(java.util.ArrayList<Playlist> playlists) 
      static java.util.ArrayList<Playlist>delPlaylist(java.util.ArrayList<Playlist> playlists) 
      static java.util.ArrayListextract(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 voidlistAlbumsByDate() 
      static voidlistAlbumsByGenre() 
      static voidlistAudioBooksByAuthor() 
      static voidlistById(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 voidlistPlaylistsByName() 
      static voidmain(java.lang.String[] args) 
      static voidsave(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)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html new file mode 100644 index 0000000..a883888 --- /dev/null +++ b/javadoc/overview-tree.html @@ -0,0 +1,151 @@ + + + + + +Class Hierarchy + + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For All Packages

+
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/package-frame.html b/javadoc/package-frame.html new file mode 100644 index 0000000..cb38865 --- /dev/null +++ b/javadoc/package-frame.html @@ -0,0 +1,31 @@ + + + + + +<Unnamed> + + + + + +

<Unnamed>

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/package-list b/javadoc/package-list new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/javadoc/package-list @@ -0,0 +1 @@ + diff --git a/javadoc/package-summary.html b/javadoc/package-summary.html new file mode 100644 index 0000000..8ce57fa --- /dev/null +++ b/javadoc/package-summary.html @@ -0,0 +1,186 @@ + + + + + + + + + + + + +
+ + + + + + + +
+ + +
+

Package <Unnamed>

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/package-tree.html b/javadoc/package-tree.html new file mode 100644 index 0000000..a2f09f5 --- /dev/null +++ b/javadoc/package-tree.html @@ -0,0 +1,151 @@ + + + + + + Class Hierarchy + + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package <Unnamed>

+
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/script.js b/javadoc/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html new file mode 100644 index 0000000..d6a9101 --- /dev/null +++ b/javadoc/serialized-form.html @@ -0,0 +1,280 @@ + + + + + +Serialized Form + + + + + + + + +
+ + + + + + + +
+ + +
+

Serialized Form

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} -- cgit v1.2.3