Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.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>Layer2AbstractMatcher</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="Layer2AbstractMatcher";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6};
  22 var tabs = {65535:["t0","All 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>Prev&nbsp;Class</li>
  52 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53 </ul>
  54 <ul class="navList">
  55 <li><a href="../../../../../index.html?edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" target="_top">Frames</a></li>
  56 <li><a href="Layer2AbstractMatcher.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.detection.layer2</div>
  95 <h2 title="Class Layer2AbstractMatcher" class="title">Class Layer2AbstractMatcher</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.detection.layer2.Layer2AbstractMatcher</li>
 103 </ul>
 104 </li>
 105 </ul>
 106 <div class="description">
 107 <ul class="blockList">
 108 <li class="blockList">
 109 <dl>
 110 <dt>Direct Known Subclasses:</dt>
 111 <dd><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2RangeMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2RangeMatcher</a>, <a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2SequenceMatcher</a></dd>
 112 </dl>
 113 <hr>
 114 <br>
 115 <pre>public abstract class <span class="typeNameLabel">Layer2AbstractMatcher</span>
 116 extends java.lang.Object</pre>
 117 <div class="block">Base class for layer 2 matchers (<code>Layer2SequenceMatcher</code> and <code>Layer2RangeMatcher</code>).</div>
 118 </li>
 119 </ul>
 120 </div>
 121 <div class="summary">
 122 <ul class="blockList">
 123 <li class="blockList">
 124 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 125 <ul class="blockList">
 126 <li class="blockList"><a name="constructor.summary">
 127 <!--   -->
 128 </a>
 129 <h3>Constructor Summary</h3>
 130 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 131 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 132 <tr>
 133 <th class="colOne" scope="col">Constructor and Description</th>
 134 </tr>
 135 <tr class="altColor">
 136 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#Layer2AbstractMatcher-java.util.List-">Layer2AbstractMatcher</a></span>(java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;sequence)</code>
 137 <div class="block">Create a <code>Layer2AbstractMatcher</code>.</div>
 138 </td>
 139 </tr>
 140 </table>
 141 </li>
 142 </ul>
 143 <!-- ========== METHOD SUMMARY =========== -->
 144 <ul class="blockList">
 145 <li class="blockList"><a name="method.summary">
 146 <!--   -->
 147 </a>
 148 <h3>Method Summary</h3>
 149 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 150 <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="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>
 151 <tr>
 152 <th class="colFirst" scope="col">Modifier and Type</th>
 153 <th class="colLast" scope="col">Method and Description</th>
 154 </tr>
 155 <tr id="i0" class="altColor">
 156 <td class="colFirst"><code>org.pcap4j.core.PcapPacket</code></td>
 157 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getLastPacket--">getLastPacket</a></span>()</code>
 158 <div class="block">Utility for <code>getMatchedPackets().get(getMatchedPackets().size()-1)</code>.</div>
 159 </td>
 160 </tr>
 161 <tr id="i1" class="rowColor">
 162 <td class="colFirst"><code>java.util.List&lt;org.pcap4j.core.PcapPacket&gt;</code></td>
 163 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getMatchedPackets--">getMatchedPackets</a></span>()</code>&nbsp;</td>
 164 </tr>
 165 <tr id="i2" class="altColor">
 166 <td class="colFirst"><code>int</code></td>
 167 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getMatchedPacketsCount--">getMatchedPacketsCount</a></span>()</code>&nbsp;</td>
 168 </tr>
 169 <tr id="i3" class="rowColor">
 170 <td class="colFirst"><code>abstract int</code></td>
 171 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getTargetSequencePacketCount--">getTargetSequencePacketCount</a></span>()</code>
 172 <div class="block">See the implementer class for the following method.</div>
 173 </td>
 174 </tr>
 175 <tr id="i4" class="altColor">
 176 <td class="colFirst"><code>abstract boolean</code></td>
 177 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#matchPacket-org.pcap4j.core.PcapPacket-">matchPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>
 178 <div class="block">See the implementer class for the following method.</div>
 179 </td>
 180 </tr>
 181 </table>
 182 <ul class="blockList">
 183 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 184 <!--   -->
 185 </a>
 186 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 187 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 188 </ul>
 189 </li>
 190 </ul>
 191 </li>
 192 </ul>
 193 </div>
 194 <div class="details">
 195 <ul class="blockList">
 196 <li class="blockList">
 197 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 198 <ul class="blockList">
 199 <li class="blockList"><a name="constructor.detail">
 200 <!--   -->
 201 </a>
 202 <h3>Constructor Detail</h3>
 203 <a name="Layer2AbstractMatcher-java.util.List-">
 204 <!--   -->
 205 </a>
 206 <ul class="blockListLast">
 207 <li class="blockList">
 208 <h4>Layer2AbstractMatcher</h4>
 209 <pre>public&nbsp;Layer2AbstractMatcher(java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;sequence)</pre>
 210 <div class="block">Create a <code>Layer2AbstractMatcher</code>.</div>
 211 <dl>
 212 <dt><span class="paramLabel">Parameters:</span></dt>
 213 <dd><code>sequence</code> - The sequence of the signature.</dd>
 214 </dl>
 215 </li>
 216 </ul>
 217 </li>
 218 </ul>
 219 <!-- ============ METHOD DETAIL ========== -->
 220 <ul class="blockList">
 221 <li class="blockList"><a name="method.detail">
 222 <!--   -->
 223 </a>
 224 <h3>Method Detail</h3>
 225 <a name="matchPacket-org.pcap4j.core.PcapPacket-">
 226 <!--   -->
 227 </a>
 228 <ul class="blockList">
 229 <li class="blockList">
 230 <h4>matchPacket</h4>
 231 <pre>public abstract&nbsp;boolean&nbsp;matchPacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
 232 <div class="block">See the implementer class for the following method.</div>
 233 <dl>
 234 <dt><span class="paramLabel">Parameters:</span></dt>
 235 <dd><code>packet</code> - </dd>
 236 <dt><span class="returnLabel">Returns:</span></dt>
 237 <dd><code>true</code> if this <code>Layer2SequenceMatcher</code> could advance by adding <code>packet</code> to its set of
 238          matched packets, <code>false</code> otherwise.</dd>
 239 </dl>
 240 </li>
 241 </ul>
 242 <a name="getTargetSequencePacketCount--">
 243 <!--   -->
 244 </a>
 245 <ul class="blockList">
 246 <li class="blockList">
 247 <h4>getTargetSequencePacketCount</h4>
 248 <pre>public abstract&nbsp;int&nbsp;getTargetSequencePacketCount()</pre>
 249 <div class="block">See the implementer class for the following method.</div>
 250 </li>
 251 </ul>
 252 <a name="getMatchedPacketsCount--">
 253 <!--   -->
 254 </a>
 255 <ul class="blockList">
 256 <li class="blockList">
 257 <h4>getMatchedPacketsCount</h4>
 258 <pre>public&nbsp;int&nbsp;getMatchedPacketsCount()</pre>
 259 </li>
 260 </ul>
 261 <a name="getMatchedPackets--">
 262 <!--   -->
 263 </a>
 264 <ul class="blockList">
 265 <li class="blockList">
 266 <h4>getMatchedPackets</h4>
 267 <pre>public&nbsp;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;getMatchedPackets()</pre>
 268 </li>
 269 </ul>
 270 <a name="getLastPacket--">
 271 <!--   -->
 272 </a>
 273 <ul class="blockListLast">
 274 <li class="blockList">
 275 <h4>getLastPacket</h4>
 276 <pre>public&nbsp;org.pcap4j.core.PcapPacket&nbsp;getLastPacket()</pre>
 277 <div class="block">Utility for <code>getMatchedPackets().get(getMatchedPackets().size()-1)</code>.</div>
 278 <dl>
 279 <dt><span class="returnLabel">Returns:</span></dt>
 280 <dd>The last matched packet, or <code>null</code> if no packets have been matched yet.</dd>
 281 </dl>
 282 </li>
 283 </ul>
 284 </li>
 285 </ul>
 286 </li>
 287 </ul>
 288 </div>
 289 </div>
 290 <!-- ========= END OF CLASS DATA ========= -->
 291 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 292 <div class="bottomNav"><a name="navbar.bottom">
 293 <!--   -->
 294 </a>
 295 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 296 <a name="navbar.bottom.firstrow">
 297 <!--   -->
 298 </a>
 299 <ul class="navList" title="Navigation">
 300 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 301 <li><a href="package-summary.html">Package</a></li>
 302 <li class="navBarCell1Rev">Class</li>
 303 <li><a href="package-tree.html">Tree</a></li>
 304 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 305 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
 306 <li><a href="../../../../../help-doc.html">Help</a></li>
 307 </ul>
 308 </div>
 309 <div class="subNav">
 310 <ul class="navList">
 311 <li>Prev&nbsp;Class</li>
 312 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 313 </ul>
 314 <ul class="navList">
 315 <li><a href="../../../../../index.html?edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" target="_top">Frames</a></li>
 316 <li><a href="Layer2AbstractMatcher.html" target="_top">No&nbsp;Frames</a></li>
 317 </ul>
 318 <ul class="navList" id="allclasses_navbar_bottom">
 319 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 320 </ul>
 321 <div>
 322 <script type="text/javascript"><!--
 323   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 324   if(window==top) {
 325     allClassesLink.style.display = "block";
 326   }
 327   else {
 328     allClassesLink.style.display = "none";
 329   }
 330   //-->
 331 </script>
 332 </div>
 333 <div>
 334 <ul class="subNavList">
 335 <li>Summary:&nbsp;</li>
 336 <li>Nested&nbsp;|&nbsp;</li>
 337 <li>Field&nbsp;|&nbsp;</li>
 338 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 339 <li><a href="#method.summary">Method</a></li>
 340 </ul>
 341 <ul class="subNavList">
 342 <li>Detail:&nbsp;</li>
 343 <li>Field&nbsp;|&nbsp;</li>
 344 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 345 <li><a href="#method.detail">Method</a></li>
 346 </ul>
 347 </div>
 348 <a name="skip.navbar.bottom">
 349 <!--   -->
 350 </a></div>
 351 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 352 </body>
 353 </html>