diff options
| author | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 17:31:33 +0100 |
|---|---|---|
| committer | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 17:31:33 +0100 |
| commit | 7c23f453d166d396451504e26fbb385afc0c4c13 (patch) | |
| tree | 01aee8bfcd409dbaa3e90889295869903a4ab5d5 /javadoc/Playlist.html | |
| parent | de39259ada4f75ac987f9bd8f0674ebede75a0de (diff) | |
Finishing javadoc
Diffstat (limited to 'javadoc/Playlist.html')
| -rw-r--r-- | javadoc/Playlist.html | 75 |
1 files changed, 65 insertions, 10 deletions
diff --git a/javadoc/Playlist.html b/javadoc/Playlist.html index 56c9b27..1bc1c8d 100644 --- a/javadoc/Playlist.html +++ b/javadoc/Playlist.html @@ -2,7 +2,7 @@ <!-- NewPage --> <html lang="fr"> <head> -<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 15:55:07 CET 2020 --> +<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 17:30:46 CET 2020 --> <title>Playlist</title> <meta name="date" content="2020-12-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> @@ -113,9 +113,12 @@ var activeTableTab = "activeTableTab"; <pre>public class <span class="typeNameLabel">Playlist</span> extends java.lang.Object implements java.io.Serializable</pre> +<div class="block">The Playlist class is used to create playlists containing songs and audiobooks.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="serialized-form.html#Playlist">Serialized Form</a></dd> +<dd><a href="Song.html" title="class in <Unnamed>"><code>Song</code></a>, +<a href="AudioBook.html" title="class in <Unnamed>"><code>AudioBook</code></a>, +<a href="serialized-form.html#Playlist">Serialized Form</a></dd> </dl> </li> </ul> @@ -137,7 +140,9 @@ implements java.io.Serializable</pre> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="Playlist.html#Playlist-java.lang.String-java.util.ArrayList-java.util.ArrayList-">Playlist</a></span>(java.lang.String name, java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs, - java.util.ArrayList<<a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a>> audiobooks)</code> </td> + java.util.ArrayList<<a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a>> audiobooks)</code> +<div class="block">Constructor method.</div> +</td> </tr> </table> </li> @@ -156,31 +161,45 @@ implements java.io.Serializable</pre> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getAudioBooks--">getAudioBooks</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getAudioBooks--">getAudioBooks</a></span>()</code> +<div class="block">This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getId--">getId</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getId--">getId</a></span>()</code> +<div class="block">This method is used to give the id of the playlist.</div> +</td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getName--">getName</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getName--">getName</a></span>()</code> +<div class="block">This method is used to give the name of the playlist in uppercase.</div> +</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getSongs--">getSongs</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#getSongs--">getSongs</a></span>()</code> +<div class="block">This method is used to print the each songs contained in the songs attribute of the playlist.</div> +</td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setId-int-">setId</a></span>(int id)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setId-int-">setId</a></span>(int id)</code> +<div class="block">Basic method to set the id of the playlist.</div> +</td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code> +<div class="block">Basic method to set the name of the playlist.</div> +</td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#toString--">toString</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Playlist.html#toString--">toString</a></span>()</code> +<div class="block">Basic method to "configure" what does a print of this object actually does.</div> +</td> </tr> </table> <ul class="blockList"> @@ -213,6 +232,16 @@ implements java.io.Serializable</pre> <pre>public Playlist(java.lang.String name, java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs, java.util.ArrayList<<a href="AudioBook.html" title="class in <Unnamed>">AudioBook</a>> audiobooks)</pre> +<div class="block">Constructor method.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - String</dd> +<dd><code>songs</code> - ArrayList</dd> +<dd><code>audiobooks</code> - ArrayList</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Song.html" title="class in <Unnamed>"><code>Song</code></a>, +<a href="AudioBook.html" title="class in <Unnamed>"><code>AudioBook</code></a></dd> +</dl> </li> </ul> </li> @@ -230,6 +259,11 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>getId</h4> <pre>public int getId()</pre> +<div class="block">This method is used to give the id of the playlist.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>id int</dd> +</dl> </li> </ul> <a name="getName--"> @@ -239,6 +273,12 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>getName</h4> <pre>public java.lang.String getName()</pre> +<div class="block">This method is used to give the name of the playlist in uppercase. + Using toUpperCase method because the way I sort by name sorts the upper case then the lower case, which is inconvenient.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>name.toUpperCase String</dd> +</dl> </li> </ul> <a name="getSongs--"> @@ -248,6 +288,7 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>getSongs</h4> <pre>public void getSongs()</pre> +<div class="block">This method is used to print the each songs contained in the songs attribute of the playlist.</div> </li> </ul> <a name="getAudioBooks--"> @@ -257,6 +298,7 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>getAudioBooks</h4> <pre>public void getAudioBooks()</pre> +<div class="block">This method is used to print the each audiobooks contained in the audiobooks attribute of the playlist.</div> </li> </ul> <a name="setId-int-"> @@ -266,6 +308,11 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>setId</h4> <pre>public void setId(int id)</pre> +<div class="block">Basic method to set the id of the playlist.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - int</dd> +</dl> </li> </ul> <a name="setName-java.lang.String-"> @@ -275,6 +322,11 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>setName</h4> <pre>public void setName(java.lang.String name)</pre> +<div class="block">Basic method to set the name of the playlist.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - String</dd> +</dl> </li> </ul> <a name="toString--"> @@ -284,9 +336,12 @@ implements java.io.Serializable</pre> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> +<div class="block">Basic method to "configure" what does a print of this object actually does.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>String, using the object's methods</dd> </dl> </li> </ul> |