diff options
| author | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 16:09:37 +0100 |
|---|---|---|
| committer | Clyhtsuriva <aimeric@adjutor.xyz> | 2020-12-28 16:09:37 +0100 |
| commit | de39259ada4f75ac987f9bd8f0674ebede75a0de (patch) | |
| tree | e9987d753d0183880117bd89135adaf7ac3b135b /javadoc/Album.html | |
| parent | e28cfe68365eecd5c4f1d9bfd92c225ccd1a4697 (diff) | |
Starting javadoc
Diffstat (limited to 'javadoc/Album.html')
| -rw-r--r-- | javadoc/Album.html | 546 |
1 files changed, 546 insertions, 0 deletions
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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 15:55:07 CET 2020 --> +<title>Album</title> +<meta name="date" content="2020-12-28"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<script type="text/javascript" src="script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Album"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="AudioBook.html" title="class in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="index.html?Album.html" target="_top">Frames</a></li> +<li><a href="Album.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<h2 title="Class Album" class="title">Class Album</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>Album</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Album</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">The album class is used to create albums containing songs added after its creation and the creation of the songs.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="serialized-form.html#Album">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="Album.html#Album-java.lang.String-int-java.lang.String-java.util.Date-java.util.ArrayList-">Album</a></span>(java.lang.String title, + int duration, + java.lang.String artist, + java.util.Date date, + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs)</code> +<div class="block">Constructor method.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#addSong-Song-">addSong</a></span>(<a href="Song.html" title="class in <Unnamed>">Song</a> song)</code> +<div class="block">Mehtod to add songs, of the Song class, to the album's arrayList.</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="Album.html#getArtist--">getArtist</a></span>()</code> +<div class="block">This method is used to give the artist of the album.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getDate--">getDate</a></span>()</code> +<div class="block">This method is used to give the date of release of the album.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getDuration--">getDuration</a></span>()</code> +<div class="block">This method is used to give the duration of the album.</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="Album.html#getGenre--">getGenre</a></span>()</code> +<div class="block">This method is used for the AG command in jMusicHub.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getId--">getId</a></span>()</code> +<div class="block">This method is used to give the id of the album.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getSongs--">getSongs</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#getTitle--">getTitle</a></span>()</code> +<div class="block">This method is used to give the title of the album.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String artist)</code> +<div class="block">Basic method to set the artist of the album.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#setDate-java.util.Date-">setDate</a></span>(java.util.Date date)</code> +<div class="block">Basic method to set the date of the album.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#setId-int-">setId</a></span>(int id)</code> +<div class="block">Basic method to set the id of the album.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String title)</code> +<div class="block">Basic method to set the title of the album.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="Album.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"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Album-java.lang.String-int-java.lang.String-java.util.Date-java.util.ArrayList-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Album</h4> +<pre>public Album(java.lang.String title, + int duration, + java.lang.String artist, + java.util.Date date, + java.util.ArrayList<<a href="Song.html" title="class in <Unnamed>">Song</a>> songs)</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, calculated with the actual duration of the object's songs</dd> +<dd><code>artist</code> - String</dd> +<dd><code>date</code> - Date</dd> +<dd><code>songs</code> - ArrayList</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="MusicalElement.html" title="class in <Unnamed>"><code>MusicalElement</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public int getId()</pre> +<div class="block">This method is used to give the id of the album.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the id, which is an int.</dd> +</dl> +</li> +</ul> +<a name="getTitle--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTitle</h4> +<pre>public java.lang.String getTitle()</pre> +<div class="block">This method is used to give the title of the album.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the title, which is a String.</dd> +</dl> +</li> +</ul> +<a name="getDuration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDuration</h4> +<pre>public int getDuration()</pre> +<div class="block">This method is used to give the duration of the album. + It calculates it by getting the duration of each songs.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the total duration, which is an int.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="MusicalElement.html#getDuration--"><code>MusicalElement.getDuration()</code></a></dd> +</dl> +</li> +</ul> +<a name="getArtist--"> +<!-- --> +</a> +<ul class="blockList"> +<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 album.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the artist, which is a String.</dd> +</dl> +</li> +</ul> +<a name="getDate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate()</pre> +<div class="block">This method is used to give the date of release of the album.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the date, which is a Date.</dd> +</dl> +</li> +</ul> +<a name="getSongs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSongs</h4> +<pre>public void getSongs()</pre> +</li> +</ul> +<a name="getGenre--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGenre</h4> +<pre>public java.lang.String getGenre()</pre> +<div class="block">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.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The genre, a Genre object, is returned.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Song.html#getGenre--"><code>Song.getGenre()</code></a>, +<a href="jMusicHub.html#listAlbumsByGenre--"><code>jMusicHub.listAlbumsByGenre()</code></a></dd> +</dl> +</li> +</ul> +<a name="setId-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setId</h4> +<pre>public void setId(int id)</pre> +<div class="block">Basic method to set the id of the album.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - int</dd> +</dl> +</li> +</ul> +<a name="setTitle-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTitle</h4> +<pre>public void setTitle(java.lang.String title)</pre> +<div class="block">Basic method to set the title of the album.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>title</code> - String</dd> +</dl> +</li> +</ul> +<a name="setArtist-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<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 album.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artist</code> - String</dd> +</dl> +</li> +</ul> +<a name="setDate-java.util.Date-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDate</h4> +<pre>public void setDate(java.util.Date date)</pre> +<div class="block">Basic method to set the date of the album.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>date</code> - Date</dd> +</dl> +</li> +</ul> +<a name="addSong-Song-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSong</h4> +<pre>public void addSong(<a href="Song.html" title="class in <Unnamed>">Song</a> song)</pre> +<div class="block">Mehtod to add songs, of the Song class, to the album's arrayList.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>song</code> - Song</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="AudioBook.html" title="class in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="index.html?Album.html" target="_top">Frames</a></li> +<li><a href="Album.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |