1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="UserAction";
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";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
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>
51 <li><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev 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 Class</span></a></li>
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 Frames</a></li>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
62 <script type="text/javascript"><!--
63 allClassesLink = document.getElementById("allclasses_navbar_top");
65 allClassesLink.style.display = "block";
68 allClassesLink.style.display = "none";
74 <ul class="subNavList">
75 <li>Summary: </li>
76 <li><a href="#nested.class.summary">Nested</a> | </li>
77 <li>Field | </li>
78 <li><a href="#constructor.summary">Constr</a> | </li>
79 <li><a href="#method.summary">Method</a></li>
81 <ul class="subNavList">
82 <li>Detail: </li>
83 <li>Field | </li>
84 <li><a href="#constructor.detail">Constr</a> | </li>
85 <li><a href="#method.detail">Method</a></li>
88 <a name="skip.navbar.top">
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
94 <div class="subTitle">edu.uci.iotproject.analysis</div>
95 <h2 title="Class UserAction" class="title">Class UserAction</h2>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
101 <ul class="inheritance">
102 <li>edu.uci.iotproject.analysis.UserAction</li>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
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>
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">
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"> </span></caption>
129 <th class="colFirst" scope="col">Modifier and Type</th>
130 <th class="colLast" scope="col">Class and Description</th>
132 <tr class="altColor">
133 <td class="colFirst"><code>static class </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>
141 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
142 <ul class="blockList">
143 <li class="blockList"><a name="constructor.summary">
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"> </span></caption>
150 <th class="colOne" scope="col">Constructor and Description</th>
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> typeOfAction,
154 java.time.Instant timeOfAction)</code> </td>
159 <!-- ========== METHOD SUMMARY =========== -->
160 <ul class="blockList">
161 <li class="blockList"><a name="method.summary">
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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
168 <th class="colFirst" scope="col">Modifier and Type</th>
169 <th class="colLast" scope="col">Method and Description</th>
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 obj)</code> </td>
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 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>
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>
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>
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> </td>
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 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
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> </td>
209 <ul class="blockList">
210 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
213 <h3>Methods inherited from class java.lang.Object</h3>
214 <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
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">
229 <h3>Constructor Detail</h3>
230 <a name="UserAction-edu.uci.iotproject.analysis.UserAction.Type-java.time.Instant-">
233 <ul class="blockListLast">
234 <li class="blockList">
236 <pre>public UserAction(<a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a> typeOfAction,
237 java.time.Instant timeOfAction)</pre>
242 <!-- ============ METHOD DETAIL ========== -->
243 <ul class="blockList">
244 <li class="blockList"><a name="method.detail">
247 <h3>Method Detail</h3>
248 <a name="setTimestampFormatter-java.time.format.DateTimeFormatter-">
251 <ul class="blockList">
252 <li class="blockList">
253 <h4>setTimestampFormatter</h4>
254 <pre>public static void setTimestampFormatter(java.time.format.DateTimeFormatter 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
258 <dt><span class="paramLabel">Parameters:</span></dt>
259 <dd><code>formatter</code> - The formatter to use for outputting and parsing.</dd>
263 <a name="fromString-java.lang.String-">
266 <ul class="blockList">
267 <li class="blockList">
269 <pre>public static <a href="../../../../edu/uci/iotproject/analysis/UserAction.html" title="class in edu.uci.iotproject.analysis">UserAction</a> fromString(java.lang.String 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>
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>
282 <ul class="blockList">
283 <li class="blockList">
285 <pre>public <a href="../../../../edu/uci/iotproject/analysis/UserAction.Type.html" title="enum in edu.uci.iotproject.analysis">UserAction.Type</a> getType()</pre>
286 <div class="block">Get the specific type of action performed by the user.</div>
288 <dt><span class="returnLabel">Returns:</span></dt>
289 <dd>the specific type of action performed by the user.</dd>
293 <a name="getTimestamp--">
296 <ul class="blockList">
297 <li class="blockList">
298 <h4>getTimestamp</h4>
299 <pre>public java.time.Instant getTimestamp()</pre>
300 <div class="block">Get the time at which the user performed this action.</div>
302 <dt><span class="returnLabel">Returns:</span></dt>
303 <dd>the time at which the user performed this action.</dd>
307 <a name="equals-java.lang.Object-">
310 <ul class="blockList">
311 <li class="blockList">
313 <pre>public boolean equals(java.lang.Object obj)</pre>
315 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
316 <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
320 <a name="hashCode--">
323 <ul class="blockList">
324 <li class="blockList">
326 <pre>public int hashCode()</pre>
328 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
329 <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
333 <a name="toString--">
336 <ul class="blockListLast">
337 <li class="blockList">
339 <pre>public java.lang.String toString()</pre>
341 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
342 <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
352 <!-- ========= END OF CLASS DATA ========= -->
353 <!-- ======= START OF BOTTOM NAVBAR ====== -->
354 <div class="bottomNav"><a name="navbar.bottom">
357 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
358 <a name="navbar.bottom.firstrow">
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>
373 <li><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev 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 Class</span></a></li>
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 Frames</a></li>
380 <ul class="navList" id="allclasses_navbar_bottom">
381 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
384 <script type="text/javascript"><!--
385 allClassesLink = document.getElementById("allclasses_navbar_bottom");
387 allClassesLink.style.display = "block";
390 allClassesLink.style.display = "none";
396 <ul class="subNavList">
397 <li>Summary: </li>
398 <li><a href="#nested.class.summary">Nested</a> | </li>
399 <li>Field | </li>
400 <li><a href="#constructor.summary">Constr</a> | </li>
401 <li><a href="#method.summary">Method</a></li>
403 <ul class="subNavList">
404 <li>Detail: </li>
405 <li>Field | </li>
406 <li><a href="#constructor.detail">Constr</a> | </li>
407 <li><a href="#method.detail">Method</a></li>
410 <a name="skip.navbar.bottom">
413 <!-- ======== END OF BOTTOM NAVBAR ======= -->