Skip to content

Commit

Permalink
Updated Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Y0GAAAA
Y0GAAAA committed Jan 22, 2021
1 parent 5a5198b commit bbad2fe
Show file tree
Hide file tree
Showing 40 changed files with 845 additions and 167 deletions.
5 changes: 3 additions & 2 deletions docs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_272) on Thu Jan 14 18:03:24 CET 2021 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 22 19:47:25 CET 2021 -->
<title>All Classes</title>
<meta name="date" content="2021-01-14">
<meta name="date" content="2021-01-22">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/y0ga/Networking/Asynchronous/AsyncTask.html" title="class in com.y0ga.Networking.Asynchronous" target="classFrame">AsyncTask</a></li>
<li><a href="com/y0ga/Networking/BandwidthLimitation.html" title="class in com.y0ga.Networking" target="classFrame">BandwidthLimitation</a></li>
<li><a href="com/y0ga/Networking/Exceptions/IllegalBandwidthException.html" title="class in com.y0ga.Networking.Exceptions" target="classFrame">IllegalBandwidthException</a></li>
<li><a href="com/y0ga/Networking/Exceptions/InvalidBufferSizeException.html" title="class in com.y0ga.Networking.Exceptions" target="classFrame">InvalidBufferSizeException</a></li>
Expand Down
5 changes: 3 additions & 2 deletions docs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_272) on Thu Jan 14 18:03:24 CET 2021 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 22 19:47:25 CET 2021 -->
<title>All Classes</title>
<meta name="date" content="2021-01-14">
<meta name="date" content="2021-01-22">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/y0ga/Networking/Asynchronous/AsyncTask.html" title="class in com.y0ga.Networking.Asynchronous">AsyncTask</a></li>
<li><a href="com/y0ga/Networking/BandwidthLimitation.html" title="class in com.y0ga.Networking">BandwidthLimitation</a></li>
<li><a href="com/y0ga/Networking/Exceptions/IllegalBandwidthException.html" title="class in com.y0ga.Networking.Exceptions">IllegalBandwidthException</a></li>
<li><a href="com/y0ga/Networking/Exceptions/InvalidBufferSizeException.html" title="class in com.y0ga.Networking.Exceptions">InvalidBufferSizeException</a></li>
Expand Down
331 changes: 331 additions & 0 deletions docs/com/y0ga/Networking/Asynchronous/AsyncTask.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,331 @@
<!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 Fri Jan 22 19:47:25 CET 2021 -->
<title>AsyncTask</title>
<meta name="date" content="2021-01-22">
<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="AsyncTask";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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="../../../../overview-summary.html">Overview</a></li>
<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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/y0ga/Networking/Asynchronous/AsyncTask.html" target="_top">Frames</a></li>
<li><a href="AsyncTask.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">
<div class="subTitle">com.y0ga.Networking.Asynchronous</div>
<h2 title="Class AsyncTask" class="title">Class AsyncTask&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.y0ga.Networking.Asynchronous.AsyncTask&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The return type of the Future.</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">AsyncTask&lt;T&gt;</span>
extends java.lang.Object</pre>
<div class="block">An awaitable asynchronous task wrapping a <code>Future</code> that can be retrieved using <a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html#getUnderlyingFuture--"><code>getUnderlyingFuture()</code></a></div>
</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">&nbsp;</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="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html#AsyncTask-java.util.concurrent.Future-">AsyncTask</a></span>(java.util.concurrent.Future&lt;<a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a>&gt;&nbsp;f)</code>
<div class="block">Creates a new instance of the class from an existing <code>Future</code></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html#await--">await</a></span>()</code>
<div class="block">Waits for the operation to complete and returns the result.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html#await-long-java.util.concurrent.TimeUnit-">await</a></span>(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</code>
<div class="block">Waits for the operation to complete within the specified delay and returns the result.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html#getUnderlyingFuture--">getUnderlyingFuture</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, 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="AsyncTask-java.util.concurrent.Future-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AsyncTask</h4>
<pre>public&nbsp;AsyncTask(java.util.concurrent.Future&lt;<a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a>&gt;&nbsp;f)</pre>
<div class="block">Creates a new instance of the class from an existing <code>Future</code></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="await--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>public&nbsp;<a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a>&nbsp;await()
throws java.lang.InterruptedException,
java.util.concurrent.ExecutionException</pre>
<div class="block">Waits for the operation to complete and returns the result.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if the task was cancelled</dd>
<dd><code>java.util.concurrent.ExecutionException</code> - if the computation threw an exception</dd>
</dl>
</li>
</ul>
<a name="await-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>public&nbsp;<a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a>&nbsp;await(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)
throws java.lang.InterruptedException,
java.util.concurrent.ExecutionException,
java.util.concurrent.TimeoutException</pre>
<div class="block">Waits for the operation to complete within the specified delay and returns the result.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if the task was cancelled</dd>
<dd><code>java.util.concurrent.ExecutionException</code> - if the computation threw an exception</dd>
<dd><code>java.util.concurrent.TimeoutException</code> - if the task timed out</dd>
</dl>
</li>
</ul>
<a name="getUnderlyingFuture--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getUnderlyingFuture</h4>
<pre>public&nbsp;java.util.concurrent.Future&lt;<a href="../../../../com/y0ga/Networking/Asynchronous/AsyncTask.html" title="type parameter in AsyncTask">T</a>&gt;&nbsp;getUnderlyingFuture()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the underlying future that this class is wrapping</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="../../../../overview-summary.html">Overview</a></li>
<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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/y0ga/Networking/Asynchronous/AsyncTask.html" target="_top">Frames</a></li>
<li><a href="AsyncTask.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
20 changes: 20 additions & 0 deletions docs/com/y0ga/Networking/Asynchronous/package-frame.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!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 Fri Jan 22 19:47:25 CET 2021 -->
<title>com.y0ga.Networking.Asynchronous</title>
<meta name="date" content="2021-01-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<h1 class="bar"><a href="../../../../com/y0ga/Networking/Asynchronous/package-summary.html" target="classFrame">com.y0ga.Networking.Asynchronous</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="AsyncTask.html" title="class in com.y0ga.Networking.Asynchronous" target="classFrame">AsyncTask</a></li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit bbad2fe

Please sign in to comment.