Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / evaluation / SanitySignatureGenerator.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:59 PDT 2019 -->
6 <title>SanitySignatureGenerator</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="SanitySignatureGenerator";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/evaluation/DetectionResultsAnalyzer.html" title="class in edu.uci.iotproject.evaluation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li>Next&nbsp;Class</li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../index.html?edu/uci/iotproject/evaluation/SanitySignatureGenerator.html" target="_top">Frames</a></li>
56 <li><a href="SanitySignatureGenerator.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>Field&nbsp;|&nbsp;</li>
78 <li><a href="#constructor.summary">Constr</a>&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>Field&nbsp;|&nbsp;</li>
84 <li><a href="#constructor.detail">Constr</a>&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.evaluation</div>
95 <h2 title="Class SanitySignatureGenerator" class="title">Class SanitySignatureGenerator</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>edu.uci.iotproject.evaluation.SanitySignatureGenerator</li>
103 </ul>
104 </li>
105 </ul>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
109 <hr>
110 <br>
111 <pre>public class <span class="typeNameLabel">SanitySignatureGenerator</span>
112 extends java.lang.Object</pre>
113 <div class="block">Hacky utility for producing a sanity signature for negative test sets.
114  <p>
115  More precisely, given information about packet lengths and packet directions known to be present in an input trace,
116  this class locates the first occurrence of a matching sequence in the input trace and outputs it to a file in the
117  signature format (i.e., a <code>List&lt;List&lt;List&lt;PcapPacket&gt;&gt;&gt;</code>.
118  </p>
119  <p>
120      Note: can only produce simplistic signatures, i.e., a signature that is a <em>single</em> packet sequence that
121      occurs on a single TCP connection.
122  </p></div>
123 </li>
124 </ul>
125 </div>
126 <div class="summary">
127 <ul class="blockList">
128 <li class="blockList">
129 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
130 <ul class="blockList">
131 <li class="blockList"><a name="constructor.summary">
132 <!--   -->
133 </a>
134 <h3>Constructor Summary</h3>
135 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
136 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
137 <tr>
138 <th class="colOne" scope="col">Constructor and Description</th>
139 </tr>
140 <tr class="altColor">
141 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/evaluation/SanitySignatureGenerator.html#SanitySignatureGenerator--">SanitySignatureGenerator</a></span>()</code>&nbsp;</td>
142 </tr>
143 </table>
144 </li>
145 </ul>
146 <!-- ========== METHOD SUMMARY =========== -->
147 <ul class="blockList">
148 <li class="blockList"><a name="method.summary">
149 <!--   -->
150 </a>
151 <h3>Method Summary</h3>
152 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
153 <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
154 <tr>
155 <th class="colFirst" scope="col">Modifier and Type</th>
156 <th class="colLast" scope="col">Method and Description</th>
157 </tr>
158 <tr id="i0" class="altColor">
159 <td class="colFirst"><code>static void</code></td>
160 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/evaluation/SanitySignatureGenerator.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>&nbsp;</td>
161 </tr>
162 </table>
163 <ul class="blockList">
164 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
165 <!--   -->
166 </a>
167 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
168 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
169 </ul>
170 </li>
171 </ul>
172 </li>
173 </ul>
174 </div>
175 <div class="details">
176 <ul class="blockList">
177 <li class="blockList">
178 <!-- ========= CONSTRUCTOR DETAIL ======== -->
179 <ul class="blockList">
180 <li class="blockList"><a name="constructor.detail">
181 <!--   -->
182 </a>
183 <h3>Constructor Detail</h3>
184 <a name="SanitySignatureGenerator--">
185 <!--   -->
186 </a>
187 <ul class="blockListLast">
188 <li class="blockList">
189 <h4>SanitySignatureGenerator</h4>
190 <pre>public&nbsp;SanitySignatureGenerator()</pre>
191 </li>
192 </ul>
193 </li>
194 </ul>
195 <!-- ============ METHOD DETAIL ========== -->
196 <ul class="blockList">
197 <li class="blockList"><a name="method.detail">
198 <!--   -->
199 </a>
200 <h3>Method Detail</h3>
201 <a name="main-java.lang.String:A-">
202 <!--   -->
203 </a>
204 <ul class="blockListLast">
205 <li class="blockList">
206 <h4>main</h4>
207 <pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)
208                  throws org.pcap4j.core.PcapNativeException,
209                         org.pcap4j.core.NotOpenException</pre>
210 <dl>
211 <dt><span class="throwsLabel">Throws:</span></dt>
212 <dd><code>org.pcap4j.core.PcapNativeException</code></dd>
213 <dd><code>org.pcap4j.core.NotOpenException</code></dd>
214 </dl>
215 </li>
216 </ul>
217 </li>
218 </ul>
219 </li>
220 </ul>
221 </div>
222 </div>
223 <!-- ========= END OF CLASS DATA ========= -->
224 <!-- ======= START OF BOTTOM NAVBAR ====== -->
225 <div class="bottomNav"><a name="navbar.bottom">
226 <!--   -->
227 </a>
228 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
229 <a name="navbar.bottom.firstrow">
230 <!--   -->
231 </a>
232 <ul class="navList" title="Navigation">
233 <li><a href="../../../../overview-summary.html">Overview</a></li>
234 <li><a href="package-summary.html">Package</a></li>
235 <li class="navBarCell1Rev">Class</li>
236 <li><a href="package-tree.html">Tree</a></li>
237 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
238 <li><a href="../../../../index-files/index-1.html">Index</a></li>
239 <li><a href="../../../../help-doc.html">Help</a></li>
240 </ul>
241 </div>
242 <div class="subNav">
243 <ul class="navList">
244 <li><a href="../../../../edu/uci/iotproject/evaluation/DetectionResultsAnalyzer.html" title="class in edu.uci.iotproject.evaluation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
245 <li>Next&nbsp;Class</li>
246 </ul>
247 <ul class="navList">
248 <li><a href="../../../../index.html?edu/uci/iotproject/evaluation/SanitySignatureGenerator.html" target="_top">Frames</a></li>
249 <li><a href="SanitySignatureGenerator.html" target="_top">No&nbsp;Frames</a></li>
250 </ul>
251 <ul class="navList" id="allclasses_navbar_bottom">
252 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
253 </ul>
254 <div>
255 <script type="text/javascript"><!--
256   allClassesLink = document.getElementById("allclasses_navbar_bottom");
257   if(window==top) {
258     allClassesLink.style.display = "block";
259   }
260   else {
261     allClassesLink.style.display = "none";
262   }
263   //-->
264 </script>
265 </div>
266 <div>
267 <ul class="subNavList">
268 <li>Summary:&nbsp;</li>
269 <li>Nested&nbsp;|&nbsp;</li>
270 <li>Field&nbsp;|&nbsp;</li>
271 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
272 <li><a href="#method.summary">Method</a></li>
273 </ul>
274 <ul class="subNavList">
275 <li>Detail:&nbsp;</li>
276 <li>Field&nbsp;|&nbsp;</li>
277 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
278 <li><a href="#method.detail">Method</a></li>
279 </ul>
280 </div>
281 <a name="skip.navbar.bottom">
282 <!--   -->
283 </a></div>
284 <!-- ======== END OF BOTTOM NAVBAR ======= -->
285 </body>
286 </html>