Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / trafficreassembly / layer3 / Conversation.Direction.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (1.8.0_191) on Thu Mar 28 11:26:58 PDT 2019 -->
6 <title>Conversation.Direction</title>
7 <meta name="date" content="2019-03-28">
8 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../../../script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13     try {
14         if (location.href.indexOf('is-external=true') == -1) {
15             parent.document.title="Conversation.Direction";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":6,"i1":9,"i2":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
27 </script>
28 <noscript>
29 <div>JavaScript is disabled on your browser.</div>
30 </noscript>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
33 <!--   -->
34 </a>
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
37 <!--   -->
38 </a>
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="package-tree.html">Tree</a></li>
44 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
45 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
46 <li><a href="../../../../../help-doc.html">Help</a></li>
47 </ul>
48 </div>
49 <div class="subNav">
50 <ul class="navList">
51 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" target="_top">Frames</a></li>
56 <li><a href="Conversation.Direction.html" target="_top">No&nbsp;Frames</a></li>
57 </ul>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
60 </ul>
61 <div>
62 <script type="text/javascript"><!--
63   allClassesLink = document.getElementById("allclasses_navbar_top");
64   if(window==top) {
65     allClassesLink.style.display = "block";
66   }
67   else {
68     allClassesLink.style.display = "none";
69   }
70   //-->
71 </script>
72 </div>
73 <div>
74 <ul class="subNavList">
75 <li>Summary:&nbsp;</li>
76 <li>Nested&nbsp;|&nbsp;</li>
77 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
78 <li>Field&nbsp;|&nbsp;</li>
79 <li><a href="#method.summary">Method</a></li>
80 </ul>
81 <ul class="subNavList">
82 <li>Detail:&nbsp;</li>
83 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
84 <li>Field&nbsp;|&nbsp;</li>
85 <li><a href="#method.detail">Method</a></li>
86 </ul>
87 </div>
88 <a name="skip.navbar.top">
89 <!--   -->
90 </a></div>
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
93 <div class="header">
94 <div class="subTitle">edu.uci.iotproject.trafficreassembly.layer3</div>
95 <h2 title="Enum Conversation.Direction" class="title">Enum Conversation.Direction</h2>
96 </div>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
100 <li>
101 <ul class="inheritance">
102 <li>java.lang.Enum&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a>&gt;</li>
103 <li>
104 <ul class="inheritance">
105 <li>edu.uci.iotproject.trafficreassembly.layer3.Conversation.Direction</li>
106 </ul>
107 </li>
108 </ul>
109 </li>
110 </ul>
111 <div class="description">
112 <ul class="blockList">
113 <li class="blockList">
114 <dl>
115 <dt>All Implemented Interfaces:</dt>
116 <dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a>&gt;</dd>
117 </dl>
118 <dl>
119 <dt>Enclosing class:</dt>
120 <dd><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html" title="class in edu.uci.iotproject.trafficreassembly.layer3">Conversation</a></dd>
121 </dl>
122 <hr>
123 <br>
124 <pre>public static enum <span class="typeNameLabel">Conversation.Direction</span>
125 extends java.lang.Enum&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a>&gt;</pre>
126 <div class="block">Utility enum for expressing the direction of a packet pertaining to this <code>Conversation</code>.</div>
127 </li>
128 </ul>
129 </div>
130 <div class="summary">
131 <ul class="blockList">
132 <li class="blockList">
133 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
134 <ul class="blockList">
135 <li class="blockList"><a name="enum.constant.summary">
136 <!--   -->
137 </a>
138 <h3>Enum Constant Summary</h3>
139 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
140 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
141 <tr>
142 <th class="colOne" scope="col">Enum Constant and Description</th>
143 </tr>
144 <tr class="altColor">
145 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html#CLIENT_TO_SERVER">CLIENT_TO_SERVER</a></span></code>&nbsp;</td>
146 </tr>
147 <tr class="rowColor">
148 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html#SERVER_TO_CLIENT">SERVER_TO_CLIENT</a></span></code>&nbsp;</td>
149 </tr>
150 </table>
151 </li>
152 </ul>
153 <!-- ========== METHOD SUMMARY =========== -->
154 <ul class="blockList">
155 <li class="blockList"><a name="method.summary">
156 <!--   -->
157 </a>
158 <h3>Method Summary</h3>
159 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
160 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
161 <tr>
162 <th class="colFirst" scope="col">Modifier and Type</th>
163 <th class="colLast" scope="col">Method and Description</th>
164 </tr>
165 <tr id="i0" class="altColor">
166 <td class="colFirst"><code>abstract java.lang.String</code></td>
167 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html#toCompactString--">toCompactString</a></span>()</code>
168 <div class="block">Get a compact string representation of this <code>Direction</code>.</div>
169 </td>
170 </tr>
171 <tr id="i1" class="rowColor">
172 <td class="colFirst"><code>static <a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a></code></td>
173 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
174 <div class="block">Returns the enum constant of this type with the specified name.</div>
175 </td>
176 </tr>
177 <tr id="i2" class="altColor">
178 <td class="colFirst"><code>static <a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a>[]</code></td>
179 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html#values--">values</a></span>()</code>
180 <div class="block">Returns an array containing the constants of this enum type, in
181 the order they are declared.</div>
182 </td>
183 </tr>
184 </table>
185 <ul class="blockList">
186 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
187 <!--   -->
188 </a>
189 <h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
190 <code>compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
191 </ul>
192 <ul class="blockList">
193 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
194 <!--   -->
195 </a>
196 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
197 <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
198 </ul>
199 </li>
200 </ul>
201 </li>
202 </ul>
203 </div>
204 <div class="details">
205 <ul class="blockList">
206 <li class="blockList">
207 <!-- ============ ENUM CONSTANT DETAIL =========== -->
208 <ul class="blockList">
209 <li class="blockList"><a name="enum.constant.detail">
210 <!--   -->
211 </a>
212 <h3>Enum Constant Detail</h3>
213 <a name="CLIENT_TO_SERVER">
214 <!--   -->
215 </a>
216 <ul class="blockList">
217 <li class="blockList">
218 <h4>CLIENT_TO_SERVER</h4>
219 <pre>public static final&nbsp;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a> CLIENT_TO_SERVER</pre>
220 </li>
221 </ul>
222 <a name="SERVER_TO_CLIENT">
223 <!--   -->
224 </a>
225 <ul class="blockListLast">
226 <li class="blockList">
227 <h4>SERVER_TO_CLIENT</h4>
228 <pre>public static final&nbsp;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a> SERVER_TO_CLIENT</pre>
229 </li>
230 </ul>
231 </li>
232 </ul>
233 <!-- ============ METHOD DETAIL ========== -->
234 <ul class="blockList">
235 <li class="blockList"><a name="method.detail">
236 <!--   -->
237 </a>
238 <h3>Method Detail</h3>
239 <a name="values--">
240 <!--   -->
241 </a>
242 <ul class="blockList">
243 <li class="blockList">
244 <h4>values</h4>
245 <pre>public static&nbsp;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a>[]&nbsp;values()</pre>
246 <div class="block">Returns an array containing the constants of this enum type, in
247 the order they are declared.  This method may be used to iterate
248 over the constants as follows:
249 <pre>
250 for (Conversation.Direction c : Conversation.Direction.values())
251 &nbsp;   System.out.println(c);
252 </pre></div>
253 <dl>
254 <dt><span class="returnLabel">Returns:</span></dt>
255 <dd>an array containing the constants of this enum type, in the order they are declared</dd>
256 </dl>
257 </li>
258 </ul>
259 <a name="valueOf-java.lang.String-">
260 <!--   -->
261 </a>
262 <ul class="blockList">
263 <li class="blockList">
264 <h4>valueOf</h4>
265 <pre>public static&nbsp;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3">Conversation.Direction</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
266 <div class="block">Returns the enum constant of this type with the specified name.
267 The string must match <i>exactly</i> an identifier used to declare an
268 enum constant in this type.  (Extraneous whitespace characters are 
269 not permitted.)</div>
270 <dl>
271 <dt><span class="paramLabel">Parameters:</span></dt>
272 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
273 <dt><span class="returnLabel">Returns:</span></dt>
274 <dd>the enum constant with the specified name</dd>
275 <dt><span class="throwsLabel">Throws:</span></dt>
276 <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
277 <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
278 </dl>
279 </li>
280 </ul>
281 <a name="toCompactString--">
282 <!--   -->
283 </a>
284 <ul class="blockListLast">
285 <li class="blockList">
286 <h4>toCompactString</h4>
287 <pre>public abstract&nbsp;java.lang.String&nbsp;toCompactString()</pre>
288 <div class="block">Get a compact string representation of this <code>Direction</code>.</div>
289 <dl>
290 <dt><span class="returnLabel">Returns:</span></dt>
291 <dd>a compact string representation of this <code>Direction</code>.</dd>
292 </dl>
293 </li>
294 </ul>
295 </li>
296 </ul>
297 </li>
298 </ul>
299 </div>
300 </div>
301 <!-- ========= END OF CLASS DATA ========= -->
302 <!-- ======= START OF BOTTOM NAVBAR ====== -->
303 <div class="bottomNav"><a name="navbar.bottom">
304 <!--   -->
305 </a>
306 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
307 <a name="navbar.bottom.firstrow">
308 <!--   -->
309 </a>
310 <ul class="navList" title="Navigation">
311 <li><a href="../../../../../overview-summary.html">Overview</a></li>
312 <li><a href="package-summary.html">Package</a></li>
313 <li class="navBarCell1Rev">Class</li>
314 <li><a href="package-tree.html">Tree</a></li>
315 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
316 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
317 <li><a href="../../../../../help-doc.html">Help</a></li>
318 </ul>
319 </div>
320 <div class="subNav">
321 <ul class="navList">
322 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
323 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
324 </ul>
325 <ul class="navList">
326 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" target="_top">Frames</a></li>
327 <li><a href="Conversation.Direction.html" target="_top">No&nbsp;Frames</a></li>
328 </ul>
329 <ul class="navList" id="allclasses_navbar_bottom">
330 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
331 </ul>
332 <div>
333 <script type="text/javascript"><!--
334   allClassesLink = document.getElementById("allclasses_navbar_bottom");
335   if(window==top) {
336     allClassesLink.style.display = "block";
337   }
338   else {
339     allClassesLink.style.display = "none";
340   }
341   //-->
342 </script>
343 </div>
344 <div>
345 <ul class="subNavList">
346 <li>Summary:&nbsp;</li>
347 <li>Nested&nbsp;|&nbsp;</li>
348 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
349 <li>Field&nbsp;|&nbsp;</li>
350 <li><a href="#method.summary">Method</a></li>
351 </ul>
352 <ul class="subNavList">
353 <li>Detail:&nbsp;</li>
354 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
355 <li>Field&nbsp;|&nbsp;</li>
356 <li><a href="#method.detail">Method</a></li>
357 </ul>
358 </div>
359 <a name="skip.navbar.bottom">
360 <!--   -->
361 </a></div>
362 <!-- ======== END OF BOTTOM NAVBAR ======= -->
363 </body>
364 </html>