From de39259ada4f75ac987f9bd8f0674ebede75a0de Mon Sep 17 00:00:00 2001 From: Clyhtsuriva Date: Mon, 28 Dec 2020 16:09:37 +0100 Subject: Starting javadoc --- javadoc/jMusicHub.html | 533 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 533 insertions(+) create mode 100644 javadoc/jMusicHub.html (limited to 'javadoc/jMusicHub.html') 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 + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+

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)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + -- cgit v1.2.3