diff options
Diffstat (limited to 'javadoc/Song.html')
| -rw-r--r-- | javadoc/Song.html | 69 |
1 files changed, 60 insertions, 9 deletions
diff --git a/javadoc/Song.html b/javadoc/Song.html index 3f1712f..a9de438 100644 --- a/javadoc/Song.html +++ b/javadoc/Song.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>Song</title> <meta name="date" content="2020-12-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> @@ -117,10 +117,11 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Song</span> extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></pre> -<div class="block">Song is using instanciating MusicalElement and is Serializable.</div> +<div class="block">The Song class is used to create songs while extending MusicalElement.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="serialized-form.html#Song">Serialized Form</a></dd> +<dd><a href="MusicalElement.html" title="class in <Unnamed>"><code>MusicalElement</code></a>, +<a href="serialized-form.html#Song">Serialized Form</a></dd> </dl> </li> </ul> @@ -144,7 +145,9 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl int duration, java.lang.String content, java.lang.String artist, - <a href="Genre.html" title="enum in <Unnamed>">Genre</a> genre)</code> </td> + <a href="Genre.html" title="enum in <Unnamed>">Genre</a> genre)</code> +<div class="block">Constructor method.</div> +</td> </tr> </table> </li> @@ -163,23 +166,33 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getArtist--">getArtist</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getArtist--">getArtist</a></span>()</code> +<div class="block">This method is used to give the artist of the song.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getGenre--">getGenre</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#getGenre--">getGenre</a></span>()</code> +<div class="block">This method is used to give the genre of the song.</div> +</td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String artist)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String artist)</code> +<div class="block">Basic method to set the artist of the song.</div> +</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setGenre-Genre-">setGenre</a></span>(<a href="Genre.html" title="enum in <Unnamed>">Genre</a> genre)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#setGenre-Genre-">setGenre</a></span>(<a href="Genre.html" title="enum in <Unnamed>">Genre</a> genre)</code> +<div class="block">Basic method to set the genre of the song using the name method from the Genre class.</div> +</td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="Song.html#toString--">toString</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="Song.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"> @@ -221,6 +234,17 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl java.lang.String content, java.lang.String artist, <a href="Genre.html" title="enum in <Unnamed>">Genre</a> genre)</pre> +<div class="block">Constructor method.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>title</code> - String</dd> +<dd><code>duration</code> - int</dd> +<dd><code>content</code> - String, path to the mp3 file</dd> +<dd><code>artist</code> - String</dd> +<dd><code>genre</code> - Genre</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Genre.html" title="enum in <Unnamed>"><code>Genre</code></a></dd> +</dl> </li> </ul> </li> @@ -238,6 +262,11 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl <li class="blockList"> <h4>getArtist</h4> <pre>public java.lang.String getArtist()</pre> +<div class="block">This method is used to give the artist of the song.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>artist String</dd> +</dl> </li> </ul> <a name="getGenre--"> @@ -247,6 +276,13 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl <li class="blockList"> <h4>getGenre</h4> <pre>public java.lang.String getGenre()</pre> +<div class="block">This method is used to give the genre of the song.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the genre, which is a String because the constructor use the name method of the Genre class.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Genre.html" title="enum in <Unnamed>"><code>Genre</code></a></dd> +</dl> </li> </ul> <a name="setArtist-java.lang.String-"> @@ -256,6 +292,11 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl <li class="blockList"> <h4>setArtist</h4> <pre>public void setArtist(java.lang.String artist)</pre> +<div class="block">Basic method to set the artist of the song.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artist</code> - String</dd> +</dl> </li> </ul> <a name="setGenre-Genre-"> @@ -265,6 +306,13 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl <li class="blockList"> <h4>setGenre</h4> <pre>public void setGenre(<a href="Genre.html" title="enum in <Unnamed>">Genre</a> genre)</pre> +<div class="block">Basic method to set the genre of the song using the name method from the Genre class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>genre</code> - Genre</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Genre.html" title="enum in <Unnamed>"><code>Genre</code></a></dd> +</dl> </li> </ul> <a name="toString--"> @@ -274,9 +322,12 @@ extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalEl <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> |