Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/analysis/UserAction.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>UserAction</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="UserAction";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10};
  22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/analysis/TriggerTrafficExtractor.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52 <li><a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53 </ul>
  54 <ul class="navList">
  55 <li><a href="../../../../index.html?edu/uci/iotproject/analysis/UserAction.html" target="_top">Frames</a></li>
  56 <li><a href="UserAction.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><a href="#nested.class.summary">Nested</a>&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.analysis</div>
  95 <h2 title="Class UserAction" class="title">Class UserAction</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.analysis.UserAction</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">UserAction</span>
 112 extends java.lang.Object</pre>
 113 <div class="block">Models a user's action, such as toggling the smart plug on/off at a given time.</div>
 114 </li>
 115 </ul>
 116 </div>
 117 <div class="summary">
 118 <ul class="blockList">
 119 <li class="blockList">
 120 <!-- ======== NESTED CLASS SUMMARY ======== -->
 121 <ul class="blockList">
 122 <li class="blockList"><a name="nested.class.summary">
 123 <!--   -->
 124 </a>
 125 <h3>Nested Class Summary</h3>
 126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
 127 <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
 128 <tr>
 129 <th class="colFirst" scope="col">Modifier and Type</th>
 130 <th class="colLast" scope="col">Class and Description</th>
 131 </tr>
 132 <tr class="altColor">
 133 <td class="colFirst"><code>static class&nbsp;</code></td>
 134 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a></span></code>
 135 <div class="block">Enum for indicating what type of action the user performed.</div>
 136 </td>
 137 </tr>
 138 </table>
 139 </li>
 140 </ul>
 141 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 142 <ul class="blockList">
 143 <li class="blockList"><a name="constructor.summary">
 144 <!--   -->
 145 </a>
 146 <h3>Constructor Summary</h3>
 147 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 148 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 149 <tr>
 150 <th class="colOne" scope="col">Constructor and Description</th>
 151 </tr>
 152 <tr class="altColor">
 153 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#UserAction-edu.uci.iotproject.analysis.UserAction.Type-java.time.Instant-">UserAction</a></span>(<a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a>&nbsp;typeOfAction,
 154           java.time.Instant&nbsp;timeOfAction)</code>&nbsp;</td>
 155 </tr>
 156 </table>
 157 </li>
 158 </ul>
 159 <!-- ========== METHOD SUMMARY =========== -->
 160 <ul class="blockList">
 161 <li class="blockList"><a name="method.summary">
 162 <!--   -->
 163 </a>
 164 <h3>Method Summary</h3>
 165 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 166 <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 167 <tr>
 168 <th class="colFirst" scope="col">Modifier and Type</th>
 169 <th class="colLast" scope="col">Method and Description</th>
 170 </tr>
 171 <tr id="i0" class="altColor">
 172 <td class="colFirst"><code>boolean</code></td>
 173 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
 174 </tr>
 175 <tr id="i1" class="rowColor">
 176 <td class="colFirst"><code>static <a href="../../../../edu/uci/iotproject/analysis/UserAction.html" title="class in edu.uci.iotproject.analysis">UserAction</a></code></td>
 177 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#fromString-java.lang.String-">fromString</a></span>(java.lang.String&nbsp;string)</code>
 178 <div class="block">Instantiates a <code>UserAction</code> from a string that obeys the format used in <a href="../../../../edu/uci/iotproject/analysis/UserAction.html#toString--"><code>toString()</code></a>.</div>
 179 </td>
 180 </tr>
 181 <tr id="i2" class="altColor">
 182 <td class="colFirst"><code>java.time.Instant</code></td>
 183 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#getTimestamp--">getTimestamp</a></span>()</code>
 184 <div class="block">Get the time at which the user performed this action.</div>
 185 </td>
 186 </tr>
 187 <tr id="i3" class="rowColor">
 188 <td class="colFirst"><code><a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a></code></td>
 189 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#getType--">getType</a></span>()</code>
 190 <div class="block">Get the specific type of action performed by the user.</div>
 191 </td>
 192 </tr>
 193 <tr id="i4" class="altColor">
 194 <td class="colFirst"><code>int</code></td>
 195 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
 196 </tr>
 197 <tr id="i5" class="rowColor">
 198 <td class="colFirst"><code>static void</code></td>
 199 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#setTimestampFormatter-java.time.format.DateTimeFormatter-">setTimestampFormatter</a></span>(java.time.format.DateTimeFormatter&nbsp;formatter)</code>
 200 <div class="block">Sets the <code>DateTimeFormatter</code> used when outputting a user action as a string and parsing a user action from
 201  a string.</div>
 202 </td>
 203 </tr>
 204 <tr id="i6" class="altColor">
 205 <td class="colFirst"><code>java.lang.String</code></td>
 206 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/UserAction.html#toString--">toString</a></span>()</code>&nbsp;</td>
 207 </tr>
 208 </table>
 209 <ul class="blockList">
 210 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 211 <!--   -->
 212 </a>
 213 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 214 <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
 215 </ul>
 216 </li>
 217 </ul>
 218 </li>
 219 </ul>
 220 </div>
 221 <div class="details">
 222 <ul class="blockList">
 223 <li class="blockList">
 224 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 225 <ul class="blockList">
 226 <li class="blockList"><a name="constructor.detail">
 227 <!--   -->
 228 </a>
 229 <h3>Constructor Detail</h3>
 230 <a name="UserAction-edu.uci.iotproject.analysis.UserAction.Type-java.time.Instant-">
 231 <!--   -->
 232 </a>
 233 <ul class="blockListLast">
 234 <li class="blockList">
 235 <h4>UserAction</h4>
 236 <pre>public&nbsp;UserAction(<a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a>&nbsp;typeOfAction,
 237                   java.time.Instant&nbsp;timeOfAction)</pre>
 238 </li>
 239 </ul>
 240 </li>
 241 </ul>
 242 <!-- ============ METHOD DETAIL ========== -->
 243 <ul class="blockList">
 244 <li class="blockList"><a name="method.detail">
 245 <!--   -->
 246 </a>
 247 <h3>Method Detail</h3>
 248 <a name="setTimestampFormatter-java.time.format.DateTimeFormatter-">
 249 <!--   -->
 250 </a>
 251 <ul class="blockList">
 252 <li class="blockList">
 253 <h4>setTimestampFormatter</h4>
 254 <pre>public static&nbsp;void&nbsp;setTimestampFormatter(java.time.format.DateTimeFormatter&nbsp;formatter)</pre>
 255 <div class="block">Sets the <code>DateTimeFormatter</code> used when outputting a user action as a string and parsing a user action from
 256  a string.</div>
 257 <dl>
 258 <dt><span class="paramLabel">Parameters:</span></dt>
 259 <dd><code>formatter</code> - The formatter to use for outputting and parsing.</dd>
 260 </dl>
 261 </li>
 262 </ul>
 263 <a name="fromString-java.lang.String-">
 264 <!--   -->
 265 </a>
 266 <ul class="blockList">
 267 <li class="blockList">
 268 <h4>fromString</h4>
 269 <pre>public static&nbsp;<a href="../../../../edu/uci/iotproject/analysis/UserAction.html" title="class in edu.uci.iotproject.analysis">UserAction</a>&nbsp;fromString(java.lang.String&nbsp;string)</pre>
 270 <div class="block">Instantiates a <code>UserAction</code> from a string that obeys the format used in <a href="../../../../edu/uci/iotproject/analysis/UserAction.html#toString--"><code>toString()</code></a>.</div>
 271 <dl>
 272 <dt><span class="paramLabel">Parameters:</span></dt>
 273 <dd><code>string</code> - The string that represents a <code>UserAction</code></dd>
 274 <dt><span class="returnLabel">Returns:</span></dt>
 275 <dd>A <code>UserAction</code> resulting from deserializing the string.</dd>
 276 </dl>
 277 </li>
 278 </ul>
 279 <a name="getType--">
 280 <!--   -->
 281 </a>
 282 <ul class="blockList">
 283 <li class="blockList">
 284 <h4>getType</h4>
 285 <pre>public&nbsp;<a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a>&nbsp;getType()</pre>
 286 <div class="block">Get the specific type of action performed by the user.</div>
 287 <dl>
 288 <dt><span class="returnLabel">Returns:</span></dt>
 289 <dd>the specific type of action performed by the user.</dd>
 290 </dl>
 291 </li>
 292 </ul>
 293 <a name="getTimestamp--">
 294 <!--   -->
 295 </a>
 296 <ul class="blockList">
 297 <li class="blockList">
 298 <h4>getTimestamp</h4>
 299 <pre>public&nbsp;java.time.Instant&nbsp;getTimestamp()</pre>
 300 <div class="block">Get the time at which the user performed this action.</div>
 301 <dl>
 302 <dt><span class="returnLabel">Returns:</span></dt>
 303 <dd>the time at which the user performed this action.</dd>
 304 </dl>
 305 </li>
 306 </ul>
 307 <a name="equals-java.lang.Object-">
 308 <!--   -->
 309 </a>
 310 <ul class="blockList">
 311 <li class="blockList">
 312 <h4>equals</h4>
 313 <pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
 314 <dl>
 315 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 316 <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 317 </dl>
 318 </li>
 319 </ul>
 320 <a name="hashCode--">
 321 <!--   -->
 322 </a>
 323 <ul class="blockList">
 324 <li class="blockList">
 325 <h4>hashCode</h4>
 326 <pre>public&nbsp;int&nbsp;hashCode()</pre>
 327 <dl>
 328 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 329 <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 330 </dl>
 331 </li>
 332 </ul>
 333 <a name="toString--">
 334 <!--   -->
 335 </a>
 336 <ul class="blockListLast">
 337 <li class="blockList">
 338 <h4>toString</h4>
 339 <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
 340 <dl>
 341 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 342 <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 343 </dl>
 344 </li>
 345 </ul>
 346 </li>
 347 </ul>
 348 </li>
 349 </ul>
 350 </div>
 351 </div>
 352 <!-- ========= END OF CLASS DATA ========= -->
 353 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 354 <div class="bottomNav"><a name="navbar.bottom">
 355 <!--   -->
 356 </a>
 357 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 358 <a name="navbar.bottom.firstrow">
 359 <!--   -->
 360 </a>
 361 <ul class="navList" title="Navigation">
 362 <li><a href="../../../../overview-summary.html">Overview</a></li>
 363 <li><a href="package-summary.html">Package</a></li>
 364 <li class="navBarCell1Rev">Class</li>
 365 <li><a href="package-tree.html">Tree</a></li>
 366 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 367 <li><a href="../../../../index-files/index-1.html">Index</a></li>
 368 <li><a href="../../../../help-doc.html">Help</a></li>
 369 </ul>
 370 </div>
 371 <div class="subNav">
 372 <ul class="navList">
 373 <li><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 374 <li><a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 375 </ul>
 376 <ul class="navList">
 377 <li><a href="../../../../index.html?edu/uci/iotproject/analysis/UserAction.html" target="_top">Frames</a></li>
 378 <li><a href="UserAction.html" target="_top">No&nbsp;Frames</a></li>
 379 </ul>
 380 <ul class="navList" id="allclasses_navbar_bottom">
 381 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 382 </ul>
 383 <div>
 384 <script type="text/javascript"><!--
 385   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 386   if(window==top) {
 387     allClassesLink.style.display = "block";
 388   }
 389   else {
 390     allClassesLink.style.display = "none";
 391   }
 392   //-->
 393 </script>
 394 </div>
 395 <div>
 396 <ul class="subNavList">
 397 <li>Summary:&nbsp;</li>
 398 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 399 <li>Field&nbsp;|&nbsp;</li>
 400 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 401 <li><a href="#method.summary">Method</a></li>
 402 </ul>
 403 <ul class="subNavList">
 404 <li>Detail:&nbsp;</li>
 405 <li>Field&nbsp;|&nbsp;</li>
 406 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 407 <li><a href="#method.detail">Method</a></li>
 408 </ul>
 409 </div>
 410 <a name="skip.navbar.bottom">
 411 <!--   -->
 412 </a></div>
 413 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 414 </body>
 415 </html>