Skip to content
This repository was archived by the owner on Jul 31, 2022. It is now read-only.

Commit 66ce731

Browse files
committed
added javadoc
1 parent 2dd28be commit 66ce731

File tree

102 files changed

+60858
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+60858
-0
lines changed

docs/allclasses-index.html

Lines changed: 257 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,257 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (11) on Sun Nov 24 17:38:07 EST 2019 -->
6+
<title>All Classes</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="dc.created" content="2019-11-24">
9+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
10+
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
11+
<script type="text/javascript" src="script.js"></script>
12+
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
13+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
14+
<!--[if IE]>
15+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
16+
<![endif]-->
17+
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
18+
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
19+
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
20+
</head>
21+
<body>
22+
<script type="text/javascript"><!--
23+
try {
24+
if (location.href.indexOf('is-external=true') == -1) {
25+
parent.document.title="All Classes";
26+
}
27+
}
28+
catch(err) {
29+
}
30+
//-->
31+
var data = {"i0":1,"i1":2,"i2":2,"i3":1,"i4":1,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":4,"i13":2};
32+
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
33+
var altColor = "altColor";
34+
var rowColor = "rowColor";
35+
var tableTab = "tableTab";
36+
var activeTableTab = "activeTableTab";
37+
var pathtoroot = "./";
38+
var useModuleDirectories = true;
39+
loadScripts(document, 'script');</script>
40+
<noscript>
41+
<div>JavaScript is disabled on your browser.</div>
42+
</noscript>
43+
<header role="banner">
44+
<nav role="navigation">
45+
<div class="fixedNav">
46+
<!-- ========= START OF TOP NAVBAR ======= -->
47+
<div class="topNav"><a id="navbar.top">
48+
<!-- -->
49+
</a>
50+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
51+
<a id="navbar.top.firstrow">
52+
<!-- -->
53+
</a>
54+
<ul class="navList" title="Navigation">
55+
<li><a href="index.html">Overview</a></li>
56+
<li>Package</li>
57+
<li>Class</li>
58+
<li>Use</li>
59+
<li><a href="overview-tree.html">Tree</a></li>
60+
<li><a href="deprecated-list.html">Deprecated</a></li>
61+
<li><a href="index-files/index-1.html">Index</a></li>
62+
<li><a href="help-doc.html">Help</a></li>
63+
</ul>
64+
</div>
65+
<div class="subNav">
66+
<ul class="navList" id="allclasses_navbar_top">
67+
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
68+
</ul>
69+
<ul class="navListSearch">
70+
<li><label for="search">SEARCH:</label>
71+
<input type="text" id="search" value="search" disabled="disabled">
72+
<input type="reset" id="reset" value="reset" disabled="disabled">
73+
</li>
74+
</ul>
75+
<div>
76+
<script type="text/javascript"><!--
77+
allClassesLink = document.getElementById("allclasses_navbar_top");
78+
if(window==top) {
79+
allClassesLink.style.display = "block";
80+
}
81+
else {
82+
allClassesLink.style.display = "none";
83+
}
84+
//-->
85+
</script>
86+
<noscript>
87+
<div>JavaScript is disabled on your browser.</div>
88+
</noscript>
89+
</div>
90+
<a id="skip.navbar.top">
91+
<!-- -->
92+
</a></div>
93+
<!-- ========= END OF TOP NAVBAR ========= -->
94+
</div>
95+
<div class="navPadding">&nbsp;</div>
96+
<script type="text/javascript"><!--
97+
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
98+
//-->
99+
</script>
100+
</nav>
101+
</header>
102+
<main role="main">
103+
<div class="header">
104+
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
105+
</div>
106+
<div class="allClassesContainer">
107+
<ul class="blockList">
108+
<li class="blockList">
109+
<table class="typeSummary">
110+
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
111+
<tr>
112+
<th class="colFirst" scope="col">Class</th>
113+
<th class="colLast" scope="col">Description</th>
114+
</tr>
115+
<tr id="i0" class="altColor">
116+
<td class="colFirst"><a href="ktt/lib/httpserver/Authenticator.html" title="interface in ktt.lib.httpserver">Authenticator</a></td>
117+
<th class="colLast" scope="row">
118+
<div class="block">Before each request is processed, the authenticator determines whether to cancel the request or now.</div>
119+
</th>
120+
</tr>
121+
<tr id="i1" class="rowColor">
122+
<td class="colFirst"><a href="ktt/lib/httpserver/ExchangePacket.html" title="class in ktt.lib.httpserver">ExchangePacket</a></td>
123+
<th class="colLast" scope="row">
124+
<div class="block"><i>This class is a simplified implementation of <code>HttpExchange</code>.</i>
125+
<br>
126+
This class provides methods to examine requests from the client, and send a response back.</div>
127+
</th>
128+
</tr>
129+
<tr id="i2" class="altColor">
130+
<td class="colFirst"><a href="ktt/lib/httpserver/ExchangePacketProvider.html" title="class in ktt.lib.httpserver">ExchangePacketProvider</a></td>
131+
<th class="colLast" scope="row">
132+
<div class="block">Service provider class for <a href="ktt/lib/httpserver/ExchangePacket.html" title="class in ktt.lib.httpserver"><code>ExchangePacket</code></a>.</div>
133+
</th>
134+
</tr>
135+
<tr id="i3" class="rowColor">
136+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/FileBytesAdapter.html" title="interface in ktt.lib.httpserver.handler">FileBytesAdapter</a></td>
137+
<th class="colLast" scope="row">
138+
<div class="block">This interface determines the bytes to save when adding to the <a href="ktt/lib/httpserver/handler/FilePreHandler.html" title="class in ktt.lib.httpserver.handler"><code>FilePreHandler</code></a>.</div>
139+
</th>
140+
</tr>
141+
<tr id="i4" class="altColor">
142+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/FileNameAdapter.html" title="interface in ktt.lib.httpserver.handler">FileNameAdapter</a></td>
143+
<th class="colLast" scope="row">
144+
<div class="block">This interface determines the file name to use when adding to the <a href="ktt/lib/httpserver/handler/FilePreHandler.html" title="class in ktt.lib.httpserver.handler"><code>FilePreHandler</code></a>.</div>
145+
</th>
146+
</tr>
147+
<tr id="i5" class="rowColor">
148+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/FilePostHandler.html" title="class in ktt.lib.httpserver.handler">FilePostHandler</a></td>
149+
<th class="colLast" scope="row">
150+
<div class="block">A Request Handler that returns a file.</div>
151+
</th>
152+
</tr>
153+
<tr id="i6" class="altColor">
154+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/FilePreHandler.html" title="class in ktt.lib.httpserver.handler">FilePreHandler</a></td>
155+
<th class="colLast" scope="row">
156+
<div class="block">A Request Handler that returns a file and preloaded bytes.</div>
157+
</th>
158+
</tr>
159+
<tr id="i7" class="rowColor">
160+
<td class="colFirst"><a href="ktt/lib/httpserver/http/HTTPCode.html" title="class in ktt.lib.httpserver.http">HTTPCode</a></td>
161+
<th class="colLast" scope="row">
162+
<div class="block">A list of expected HTTP status codes.</div>
163+
</th>
164+
</tr>
165+
<tr id="i8" class="altColor">
166+
<td class="colFirst"><a href="ktt/lib/httpserver/HttpServer.html" title="class in ktt.lib.httpserver">HttpServer</a></td>
167+
<th class="colLast" scope="row">
168+
<div class="block"><i>This class is a simplified implementation of <code>HttpServer</code>.</i>
169+
<br>
170+
At least one <a href="ktt/lib/httpserver/RequestHandler.html" title="class in ktt.lib.httpserver"><code>RequestHandler</code></a> must be created in order to process requests.</div>
171+
</th>
172+
</tr>
173+
<tr id="i9" class="rowColor">
174+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/PredicateHandler.html" title="class in ktt.lib.httpserver.handler">PredicateHandler</a></td>
175+
<th class="colLast" scope="row">
176+
<div class="block">The Request Handler will process each request differently depending on the predicate.</div>
177+
</th>
178+
</tr>
179+
<tr id="i10" class="altColor">
180+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/RedirectHandler.html" title="class in ktt.lib.httpserver.handler">RedirectHandler</a></td>
181+
<th class="colLast" scope="row">
182+
<div class="block">A Request Handler that redirects to a different URL without saving to the history.</div>
183+
</th>
184+
</tr>
185+
<tr id="i11" class="rowColor">
186+
<td class="colFirst"><a href="ktt/lib/httpserver/RequestHandler.html" title="class in ktt.lib.httpserver">RequestHandler</a></td>
187+
<th class="colLast" scope="row">
188+
<div class="block"><i>This class is a simplified implementation of <code>HttpHandler</code>.</i>
189+
<br>
190+
A handler used to process HTTP exchanges.</div>
191+
</th>
192+
</tr>
193+
<tr id="i12" class="altColor">
194+
<td class="colFirst"><a href="ktt/lib/httpserver/http/RequestMethod.html" title="enum in ktt.lib.httpserver.http">RequestMethod</a></td>
195+
<th class="colLast" scope="row">
196+
<div class="block">A list of expected HTTP method requests.</div>
197+
</th>
198+
</tr>
199+
<tr id="i13" class="rowColor">
200+
<td class="colFirst"><a href="ktt/lib/httpserver/handler/RootHandler.html" title="class in ktt.lib.httpserver.handler">RootHandler</a></td>
201+
<th class="colLast" scope="row">
202+
<div class="block">By default the Http Server will use the most specific context for requests; This means however, creating a Request Handler using context <code>/</code> will process all requests without a handler instead of sending a 404 response.</div>
203+
</th>
204+
</tr>
205+
</table>
206+
</li>
207+
</ul>
208+
</div>
209+
</main>
210+
<footer role="contentinfo">
211+
<nav role="navigation">
212+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
213+
<div class="bottomNav"><a id="navbar.bottom">
214+
<!-- -->
215+
</a>
216+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
217+
<a id="navbar.bottom.firstrow">
218+
<!-- -->
219+
</a>
220+
<ul class="navList" title="Navigation">
221+
<li><a href="index.html">Overview</a></li>
222+
<li>Package</li>
223+
<li>Class</li>
224+
<li>Use</li>
225+
<li><a href="overview-tree.html">Tree</a></li>
226+
<li><a href="deprecated-list.html">Deprecated</a></li>
227+
<li><a href="index-files/index-1.html">Index</a></li>
228+
<li><a href="help-doc.html">Help</a></li>
229+
</ul>
230+
</div>
231+
<div class="subNav">
232+
<ul class="navList" id="allclasses_navbar_bottom">
233+
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
234+
</ul>
235+
<div>
236+
<script type="text/javascript"><!--
237+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
238+
if(window==top) {
239+
allClassesLink.style.display = "block";
240+
}
241+
else {
242+
allClassesLink.style.display = "none";
243+
}
244+
//-->
245+
</script>
246+
<noscript>
247+
<div>JavaScript is disabled on your browser.</div>
248+
</noscript>
249+
</div>
250+
<a id="skip.navbar.bottom">
251+
<!-- -->
252+
</a></div>
253+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
254+
</nav>
255+
</footer>
256+
</body>
257+
</html>

docs/allclasses.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (11) on Sun Nov 24 17:38:07 EST 2019 -->
6+
<title>All Classes</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="dc.created" content="2019-11-24">
9+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
10+
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
11+
<script type="text/javascript" src="script.js"></script>
12+
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
13+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
14+
<!--[if IE]>
15+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
16+
<![endif]-->
17+
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
18+
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
19+
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
20+
</head>
21+
<body>
22+
<h1 class="bar">All&nbsp;Classes</h1>
23+
<main role="main" class="indexContainer">
24+
<ul>
25+
<li><a href="ktt/lib/httpserver/Authenticator.html" title="interface in ktt.lib.httpserver"><span class="interfaceName">Authenticator</span></a></li>
26+
<li><a href="ktt/lib/httpserver/ExchangePacket.html" title="class in ktt.lib.httpserver">ExchangePacket</a></li>
27+
<li><a href="ktt/lib/httpserver/ExchangePacketProvider.html" title="class in ktt.lib.httpserver">ExchangePacketProvider</a></li>
28+
<li><a href="ktt/lib/httpserver/handler/FileBytesAdapter.html" title="interface in ktt.lib.httpserver.handler"><span class="interfaceName">FileBytesAdapter</span></a></li>
29+
<li><a href="ktt/lib/httpserver/handler/FileNameAdapter.html" title="interface in ktt.lib.httpserver.handler"><span class="interfaceName">FileNameAdapter</span></a></li>
30+
<li><a href="ktt/lib/httpserver/handler/FilePostHandler.html" title="class in ktt.lib.httpserver.handler">FilePostHandler</a></li>
31+
<li><a href="ktt/lib/httpserver/handler/FilePreHandler.html" title="class in ktt.lib.httpserver.handler">FilePreHandler</a></li>
32+
<li><a href="ktt/lib/httpserver/http/HTTPCode.html" title="class in ktt.lib.httpserver.http">HTTPCode</a></li>
33+
<li><a href="ktt/lib/httpserver/HttpServer.html" title="class in ktt.lib.httpserver">HttpServer</a></li>
34+
<li><a href="ktt/lib/httpserver/handler/PredicateHandler.html" title="class in ktt.lib.httpserver.handler">PredicateHandler</a></li>
35+
<li><a href="ktt/lib/httpserver/handler/RedirectHandler.html" title="class in ktt.lib.httpserver.handler">RedirectHandler</a></li>
36+
<li><a href="ktt/lib/httpserver/RequestHandler.html" title="class in ktt.lib.httpserver">RequestHandler</a></li>
37+
<li><a href="ktt/lib/httpserver/http/RequestMethod.html" title="enum in ktt.lib.httpserver.http">RequestMethod</a></li>
38+
<li><a href="ktt/lib/httpserver/handler/RootHandler.html" title="class in ktt.lib.httpserver.handler">RootHandler</a></li>
39+
</ul>
40+
</main>
41+
</body>
42+
</html>

0 commit comments

Comments
 (0)