diff options
Diffstat (limited to 'javadoc/AudioBook.html')
| -rw-r--r-- | javadoc/AudioBook.html | 448 |
1 files changed, 448 insertions, 0 deletions
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 @@ +<!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>AudioBook</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="AudioBook"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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><a href="Album.html" title="class in <Unnamed>"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="Category.html" title="enum in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="index.html?AudioBook.html" target="_top">Frames</a></li> +<li><a href="AudioBook.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 AudioBook" class="title">Class AudioBook</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></li> +<li> +<ul class="inheritance"> +<li>AudioBook</li> +</ul> +</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">AudioBook</span> +extends <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></pre> +<div class="block">The AudioBook class is used to create audiobooks while extending MusicalElement.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="MusicalElement.html" title="class in <Unnamed>"><code>MusicalElement</code></a>, +<a href="serialized-form.html#AudioBook">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="AudioBook.html#AudioBook-java.lang.String-int-java.lang.String-java.lang.String-Language-Category-">AudioBook</a></span>(java.lang.String title, + int duration, + java.lang.String content, + java.lang.String author, + <a href="Language.html" title="enum in <Unnamed>">Language</a> language, + <a href="Category.html" title="enum in <Unnamed>">Category</a> category)</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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="AudioBook.html#getAuthor--">getAuthor</a></span>()</code> +<div class="block">This method is used to give the author of the audiobook.</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="AudioBook.html#getCategory--">getCategory</a></span>()</code> +<div class="block">This method is used to give the category of the audiobook.</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="AudioBook.html#getLanguage--">getLanguage</a></span>()</code> +<div class="block">This method is used to give the language of the audiobook.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="AudioBook.html#setArtist-java.lang.String-">setArtist</a></span>(java.lang.String author)</code> +<div class="block">Basic method to set the author of audiobook.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="AudioBook.html#setCategory-Category-">setCategory</a></span>(<a href="Category.html" title="enum in <Unnamed>">Category</a> category)</code> +<div class="block">Basic method to set the category of the audiobook using the name method from the Category class.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="AudioBook.html#setGenre-Language-">setGenre</a></span>(<a href="Language.html" title="enum in <Unnamed>">Language</a> language)</code> +<div class="block">Basic method to set the language of the audiobook using the name method from the Language object.</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="AudioBook.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.MusicalElement"> +<!-- --> +</a> +<h3>Methods inherited from class <a href="MusicalElement.html" title="class in <Unnamed>">MusicalElement</a></h3> +<code><a href="MusicalElement.html#getContent--">getContent</a>, <a href="MusicalElement.html#getDuration--">getDuration</a>, <a href="MusicalElement.html#getId--">getId</a>, <a href="MusicalElement.html#getTitle--">getTitle</a>, <a href="MusicalElement.html#setContent-java.lang.String-">setContent</a>, <a href="MusicalElement.html#setDuration-int-">setDuration</a>, <a href="MusicalElement.html#setId-int-">setId</a>, <a href="MusicalElement.html#setTitle-java.lang.String-">setTitle</a></code></li> +</ul> +<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="AudioBook-java.lang.String-int-java.lang.String-java.lang.String-Language-Category-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AudioBook</h4> +<pre>public AudioBook(java.lang.String title, + int duration, + java.lang.String content, + java.lang.String author, + <a href="Language.html" title="enum in <Unnamed>">Language</a> language, + <a href="Category.html" title="enum in <Unnamed>">Category</a> category)</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>author</code> - String</dd> +<dd><code>language</code> - Language</dd> +<dd><code>category</code> - Category</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Language.html" title="enum in <Unnamed>"><code>Language</code></a>, +<a href="Category.html" title="enum in <Unnamed>"><code>Category</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="getAuthor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthor</h4> +<pre>public java.lang.String getAuthor()</pre> +<div class="block">This method is used to give the author of the audiobook.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the author, which is a String</dd> +</dl> +</li> +</ul> +<a name="getLanguage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLanguage</h4> +<pre>public java.lang.String getLanguage()</pre> +<div class="block">This method is used to give the language of the audiobook.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the language, which is a String because the constructor use the name method of the Language object.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Language.html" title="enum in <Unnamed>"><code>Language</code></a></dd> +</dl> +</li> +</ul> +<a name="getCategory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCategory</h4> +<pre>public java.lang.String getCategory()</pre> +<div class="block">This method is used to give the category of the audiobook.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>It returns the category, which is a String because the constructor use the name method of the Category object.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Category.html" title="enum in <Unnamed>"><code>Category</code></a></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 author)</pre> +<div class="block">Basic method to set the author of audiobook.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>author</code> - String</dd> +</dl> +</li> +</ul> +<a name="setGenre-Language-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGenre</h4> +<pre>public void setGenre(<a href="Language.html" title="enum in <Unnamed>">Language</a> language)</pre> +<div class="block">Basic method to set the language of the audiobook using the name method from the Language object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>language</code> - Language</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="Language.html" title="enum in <Unnamed>"><code>Language</code></a></dd> +</dl> +</li> +</ul> +<a name="setCategory-Category-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategory</h4> +<pre>public void setCategory(<a href="Category.html" title="enum in <Unnamed>">Category</a> category)</pre> +<div class="block">Basic method to set the category of the audiobook using the name method from the Category class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>category</code> - Category</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><a href="Album.html" title="class in <Unnamed>"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="Category.html" title="enum in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="index.html?AudioBook.html" target="_top">Frames</a></li> +<li><a href="AudioBook.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> |