Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / io / PrintWriterUtils.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>PrintWriterUtils</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="PrintWriterUtils";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":9,"i1":9,"i2":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/io/PcapHandleReader.html" title="class in edu.uci.iotproject.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li><a href="../../../../edu/uci/iotproject/io/TriggerTimesFileReader.html" title="class in edu.uci.iotproject.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../index.html?edu/uci/iotproject/io/PrintWriterUtils.html" target="_top">Frames</a></li>
56 <li><a href="PrintWriterUtils.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>Constr&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>Constr&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.io</div>
95 <h2 title="Class PrintWriterUtils" class="title">Class PrintWriterUtils</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.io.PrintWriterUtils</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 final class <span class="typeNameLabel">PrintWriterUtils</span>
112 extends java.lang.Object</pre>
113 <div class="block">Utility methods for (jointly) printing to a <code>PrintWriter</code> (and standard output).</div>
114 </li>
115 </ul>
116 </div>
117 <div class="summary">
118 <ul class="blockList">
119 <li class="blockList">
120 <!-- ========== METHOD SUMMARY =========== -->
121 <ul class="blockList">
122 <li class="blockList"><a name="method.summary">
123 <!--   -->
124 </a>
125 <h3>Method Summary</h3>
126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
127 <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>
128 <tr>
129 <th class="colFirst" scope="col">Modifier and Type</th>
130 <th class="colLast" scope="col">Method and Description</th>
131 </tr>
132 <tr id="i0" class="altColor">
133 <td class="colFirst"><code>static void</code></td>
134 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/io/PrintWriterUtils.html#print-java.lang.Object-java.io.PrintWriter-boolean-">print</a></span>(java.lang.Object&nbsp;line,
135      java.io.PrintWriter&nbsp;writer,
136      boolean&nbsp;duplicateToStdOut)</code>
137 <div class="block">Invoke <code>PrintWriter.println(Object)</code> passing <code>line</code> as argument while also printing <code>line</code> to
138  standard output if <code>duplicateToStdOut</code> is <code>true</code>.</div>
139 </td>
140 </tr>
141 <tr id="i1" class="rowColor">
142 <td class="colFirst"><code>static void</code></td>
143 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/io/PrintWriterUtils.html#printEmptyLine-java.io.PrintWriter-boolean-">printEmptyLine</a></span>(java.io.PrintWriter&nbsp;writer,
144               boolean&nbsp;duplicateToStdOut)</code>
145 <div class="block">Make writer (and standard output, if <code>duplicateToStdOut</code> is <code>true</code>) print an empty line.</div>
146 </td>
147 </tr>
148 <tr id="i2" class="altColor">
149 <td class="colFirst"><code>static void</code></td>
150 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/io/PrintWriterUtils.html#println-java.lang.Object-java.io.PrintWriter-boolean-">println</a></span>(java.lang.Object&nbsp;line,
151        java.io.PrintWriter&nbsp;writer,
152        boolean&nbsp;duplicateToStdOut)</code>
153 <div class="block">Invoke <code>PrintWriter.println(Object)</code> passing <code>line</code> as argument while also printing <code>line</code> to
154  standard output if <code>duplicateToStdOut</code> is <code>true</code>.</div>
155 </td>
156 </tr>
157 </table>
158 <ul class="blockList">
159 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
160 <!--   -->
161 </a>
162 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
163 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
164 </ul>
165 </li>
166 </ul>
167 </li>
168 </ul>
169 </div>
170 <div class="details">
171 <ul class="blockList">
172 <li class="blockList">
173 <!-- ============ METHOD DETAIL ========== -->
174 <ul class="blockList">
175 <li class="blockList"><a name="method.detail">
176 <!--   -->
177 </a>
178 <h3>Method Detail</h3>
179 <a name="println-java.lang.Object-java.io.PrintWriter-boolean-">
180 <!--   -->
181 </a>
182 <ul class="blockList">
183 <li class="blockList">
184 <h4>println</h4>
185 <pre>public static&nbsp;void&nbsp;println(java.lang.Object&nbsp;line,
186                            java.io.PrintWriter&nbsp;writer,
187                            boolean&nbsp;duplicateToStdOut)</pre>
188 <div class="block">Invoke <code>PrintWriter.println(Object)</code> passing <code>line</code> as argument while also printing <code>line</code> to
189  standard output if <code>duplicateToStdOut</code> is <code>true</code>.</div>
190 <dl>
191 <dt><span class="paramLabel">Parameters:</span></dt>
192 <dd><code>line</code> - The line to be printed.</dd>
193 <dd><code>writer</code> - The <code>PrintWriter</code> that is to print <code>line</code>.</dd>
194 <dd><code>duplicateToStdOut</code> - Set to <code>true</code> if <code>line</code> should also be printed in standard output.</dd>
195 </dl>
196 </li>
197 </ul>
198 <a name="print-java.lang.Object-java.io.PrintWriter-boolean-">
199 <!--   -->
200 </a>
201 <ul class="blockList">
202 <li class="blockList">
203 <h4>print</h4>
204 <pre>public static&nbsp;void&nbsp;print(java.lang.Object&nbsp;line,
205                          java.io.PrintWriter&nbsp;writer,
206                          boolean&nbsp;duplicateToStdOut)</pre>
207 <div class="block">Invoke <code>PrintWriter.println(Object)</code> passing <code>line</code> as argument while also printing <code>line</code> to
208  standard output if <code>duplicateToStdOut</code> is <code>true</code>.</div>
209 <dl>
210 <dt><span class="paramLabel">Parameters:</span></dt>
211 <dd><code>line</code> - The line to be printed.</dd>
212 <dd><code>writer</code> - The <code>PrintWriter</code> that is to print <code>line</code>.</dd>
213 <dd><code>duplicateToStdOut</code> - Set to <code>true</code> if <code>line</code> should also be printed in standard output.</dd>
214 </dl>
215 </li>
216 </ul>
217 <a name="printEmptyLine-java.io.PrintWriter-boolean-">
218 <!--   -->
219 </a>
220 <ul class="blockListLast">
221 <li class="blockList">
222 <h4>printEmptyLine</h4>
223 <pre>public static&nbsp;void&nbsp;printEmptyLine(java.io.PrintWriter&nbsp;writer,
224                                   boolean&nbsp;duplicateToStdOut)</pre>
225 <div class="block">Make writer (and standard output, if <code>duplicateToStdOut</code> is <code>true</code>) print an empty line.</div>
226 <dl>
227 <dt><span class="paramLabel">Parameters:</span></dt>
228 <dd><code>writer</code> - The writer that <code>PrintWriter.println()</code> is to be invoked on.</dd>
229 <dd><code>duplicateToStdOut</code> - If <code>true</code>, prints an empty line to standard output.</dd>
230 </dl>
231 </li>
232 </ul>
233 </li>
234 </ul>
235 </li>
236 </ul>
237 </div>
238 </div>
239 <!-- ========= END OF CLASS DATA ========= -->
240 <!-- ======= START OF BOTTOM NAVBAR ====== -->
241 <div class="bottomNav"><a name="navbar.bottom">
242 <!--   -->
243 </a>
244 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
245 <a name="navbar.bottom.firstrow">
246 <!--   -->
247 </a>
248 <ul class="navList" title="Navigation">
249 <li><a href="../../../../overview-summary.html">Overview</a></li>
250 <li><a href="package-summary.html">Package</a></li>
251 <li class="navBarCell1Rev">Class</li>
252 <li><a href="package-tree.html">Tree</a></li>
253 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
254 <li><a href="../../../../index-files/index-1.html">Index</a></li>
255 <li><a href="../../../../help-doc.html">Help</a></li>
256 </ul>
257 </div>
258 <div class="subNav">
259 <ul class="navList">
260 <li><a href="../../../../edu/uci/iotproject/io/PcapHandleReader.html" title="class in edu.uci.iotproject.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
261 <li><a href="../../../../edu/uci/iotproject/io/TriggerTimesFileReader.html" title="class in edu.uci.iotproject.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
262 </ul>
263 <ul class="navList">
264 <li><a href="../../../../index.html?edu/uci/iotproject/io/PrintWriterUtils.html" target="_top">Frames</a></li>
265 <li><a href="PrintWriterUtils.html" target="_top">No&nbsp;Frames</a></li>
266 </ul>
267 <ul class="navList" id="allclasses_navbar_bottom">
268 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
269 </ul>
270 <div>
271 <script type="text/javascript"><!--
272   allClassesLink = document.getElementById("allclasses_navbar_bottom");
273   if(window==top) {
274     allClassesLink.style.display = "block";
275   }
276   else {
277     allClassesLink.style.display = "none";
278   }
279   //-->
280 </script>
281 </div>
282 <div>
283 <ul class="subNavList">
284 <li>Summary:&nbsp;</li>
285 <li>Nested&nbsp;|&nbsp;</li>
286 <li>Field&nbsp;|&nbsp;</li>
287 <li>Constr&nbsp;|&nbsp;</li>
288 <li><a href="#method.summary">Method</a></li>
289 </ul>
290 <ul class="subNavList">
291 <li>Detail:&nbsp;</li>
292 <li>Field&nbsp;|&nbsp;</li>
293 <li>Constr&nbsp;|&nbsp;</li>
294 <li><a href="#method.detail">Method</a></li>
295 </ul>
296 </div>
297 <a name="skip.navbar.bottom">
298 <!--   -->
299 </a></div>
300 <!-- ======== END OF BOTTOM NAVBAR ======= -->
301 </body>
302 </html>