-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathResponse.html
403 lines (403 loc) · 16.7 KB
/
Response.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (15) on Sun May 16 22:44:05 AEST 2021 -->
<title>Response</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-05-16">
<meta name="description" content="declaration: package: common, class: Response">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "alt-color";
var rowColor = "row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">common</a></div>
<h1 title="Class Response" class="title">Class Response<T extends <a href="dataClasses/IData.html" title="interface in common.dataClasses">IData</a>></h1>
</div>
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">common.Response<T></div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code></dd>
</dl>
<hr>
<pre>public class <span class="type-name-label">Response<T extends <a href="dataClasses/IData.html" title="interface in common.dataClasses">IData</a>></span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A package containing a response sent from the server to the client, including the state of whether the request
were successfully executed and an optional data-containing object (IData).</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../serialized-form.html#common.Response">Serialized Form</a></dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="member-summary">
<table class="summary-table">
<caption><span>Fields</span></caption>
<thead>
<tr>
<th class="col-first" scope="col">Modifier and Type</th>
<th class="col-second" scope="col">Field</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color">
<td class="col-first"><code>private <a href="Response.html" title="type parameter in Response">T</a></code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#attachment">attachment</a></span></code></th>
<td class="col-last"> </td>
</tr>
<tr class="row-color">
<td class="col-first"><code>private java.lang.Class<<a href="Response.html" title="type parameter in Response">T</a>></code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#attachmentType">attachmentType</a></span></code></th>
<td class="col-last"> </td>
</tr>
<tr class="alt-color">
<td class="col-first"><code>private boolean</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#status">status</a></span></code></th>
<td class="col-last"> </td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="member-summary">
<table class="summary-table">
<caption><span>Constructors</span></caption>
<thead>
<tr>
<th class="col-first" scope="col">Constructor</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color">
<th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E(boolean,T)">Response</a></span>​(boolean status,
<a href="Response.html" title="type parameter in Response">T</a> attachment)</code></th>
<td class="col-last">
<div class="block">Initialises a response that can be sent back to the client.</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div class="member-summary" id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<table class="summary-table" aria-labelledby="t0">
<thead>
<tr>
<th class="col-first" scope="col">Modifier and Type</th>
<th class="col-second" scope="col">Method</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color" id="i0">
<td class="col-first"><code>boolean</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#equals(java.lang.Object)">equals</a></span>​(java.lang.Object o)</code></th>
<td class="col-last">
<div class="block">Indicates if some object is equal to this instance.</div>
</td>
</tr>
<tr class="row-color" id="i1">
<td class="col-first"><code><a href="dataClasses/IData.html" title="interface in common.dataClasses">IData</a></code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getAttachment()">getAttachment</a></span>()</code></th>
<td class="col-last">
<div class="block">Retrieves the object attached to the response.</div>
</td>
</tr>
<tr class="alt-color" id="i2">
<td class="col-first"><code>java.lang.Class<<a href="Response.html" title="type parameter in Response">T</a>></code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getAttachmentType()">getAttachmentType</a></span>()</code></th>
<td class="col-last">
<div class="block">Gets the attachment's type of this request.</div>
</td>
</tr>
<tr class="row-color" id="i3">
<td class="col-first"><code>int</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="col-last">
<div class="block">Returns the hashCode of this instance.</div>
</td>
</tr>
<tr class="alt-color" id="i4">
<td class="col-first"><code>boolean</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#isFulfilled()">isFulfilled</a></span>()</code></th>
<td class="col-last">
<div class="block">Retrieves the status of the request.</div>
</td>
</tr>
<tr class="row-color" id="i5">
<td class="col-first"><code>void</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#setAttachmentType(java.lang.Class)">setAttachmentType</a></span>​(java.lang.Class<<a href="Response.html" title="type parameter in Response">T</a>> attachmentType)</code></th>
<td class="col-last">
<div class="block">Sets the type of the request's attachment</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="status">
<h3>status</h3>
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="member-name">status</span></div>
</section>
</li>
<li>
<section class="detail" id="attachment">
<h3>attachment</h3>
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="Response.html" title="type parameter in Response">T</a> extends <a href="dataClasses/IData.html" title="interface in common.dataClasses">IData</a></span> <span class="member-name">attachment</span></div>
</section>
</li>
<li>
<section class="detail" id="attachmentType">
<h3>attachmentType</h3>
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">java.lang.Class<<a href="Response.html" title="type parameter in Response">T</a> extends <a href="dataClasses/IData.html" title="interface in common.dataClasses">IData</a>></span> <span class="member-name">attachmentType</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="<init>(boolean,T)">
<h3 id="<init>(boolean,common.dataClasses.IData)">Response</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="member-name">Response</span>​(<span class="parameters">boolean status,
<a href="Response.html" title="type parameter in Response">T</a> attachment)</span></div>
<div class="block">Initialises a response that can be sent back to the client.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>status</code> - The status of whether or not the request was fulfilled.</dd>
<dd><code>attachment</code> - The object attached to the response.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="setAttachmentType(java.lang.Class)">
<h3>setAttachmentType</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="member-name">setAttachmentType</span>​(<span class="parameters">java.lang.Class<<a href="Response.html" title="type parameter in Response">T</a>> attachmentType)</span></div>
<div class="block">Sets the type of the request's attachment</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>attachmentType</code> - The type of the request's attachment.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAttachmentType()">
<h3>getAttachmentType</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.lang.Class<<a href="Response.html" title="type parameter in Response">T</a>></span> <span class="member-name">getAttachmentType</span>()</div>
<div class="block">Gets the attachment's type of this request.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The attachment's type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isFulfilled()">
<h3>isFulfilled</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="member-name">isFulfilled</span>()</div>
<div class="block">Retrieves the status of the request.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The status of whether or not the request was fulfilled.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAttachment()">
<h3>getAttachment</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="dataClasses/IData.html" title="interface in common.dataClasses">IData</a></span> <span class="member-name">getAttachment</span>()</div>
<div class="block">Retrieves the object attached to the response.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The object attached to the response.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="member-name">equals</span>​(<span class="parameters">java.lang.Object o)</span></div>
<div class="block">Indicates if some object is equal to this instance.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt>Parameters:</dt>
<dd><code>o</code> - The object to compare.</dd>
<dt>Returns:</dt>
<dd>true if the object is equal to the instance, false otherwise.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="member-name">hashCode</span>()</div>
<div class="block">Returns the hashCode of this instance.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt>Returns:</dt>
<dd>The hashCode of this instance.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottom-nav" id="navbar.bottom">
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<span class="skip-nav" id="skip.navbar.bottom">
<!-- -->
</span></nav>
</footer>
</div>
</div>
</body>
</html>