source: javadoc/genius/core/logging/FileLogger.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0
File size: 12.7 KB
Line 
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_112) on Thu Jun 21 12:05:57 CEST 2018 -->
6<title>FileLogger (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
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="FileLogger (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var 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="class-use/FileLogger.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../genius/core/logging/CsvLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/logging/StatisticsLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/logging/FileLogger.html" target="_top">Frames</a></li>
57<li><a href="FileLogger.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.logging</div>
96<h2 title="Class FileLogger" class="title">Class FileLogger</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.logging.FileLogger</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd><a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.io.Closeable, java.lang.AutoCloseable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">FileLogger</span>
117extends java.lang.Object
118implements <a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.io.Closeable</pre>
119<div class="block">Creates a file logger which will log the nego events to a csv file</div>
120</li>
121</ul>
122</div>
123<div class="summary">
124<ul class="blockList">
125<li class="blockList">
126<!-- ======== CONSTRUCTOR SUMMARY ======== -->
127<ul class="blockList">
128<li class="blockList"><a name="constructor.summary">
129<!-- -->
130</a>
131<h3>Constructor Summary</h3>
132<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
133<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
134<tr>
135<th class="colOne" scope="col">Constructor and Description</th>
136</tr>
137<tr class="altColor">
138<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/logging/FileLogger.html#FileLogger-java.lang.String-">FileLogger</a></span>(java.lang.String&nbsp;fileName)</code>&nbsp;</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="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>void</code></td>
157<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/FileLogger.html#close--">close</a></span>()</code>&nbsp;</td>
158</tr>
159<tr id="i1" class="rowColor">
160<td class="colFirst"><code>void</code></td>
161<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/FileLogger.html#notifyChange-genius.core.events.NegotiationEvent-">notifyChange</a></span>(<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&nbsp;e)</code>
162<div class="block">a notification call that occurs when something changed.</div>
163</td>
164</tr>
165</table>
166<ul class="blockList">
167<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
168<!-- -->
169</a>
170<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
171<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
172</ul>
173</li>
174</ul>
175</li>
176</ul>
177</div>
178<div class="details">
179<ul class="blockList">
180<li class="blockList">
181<!-- ========= CONSTRUCTOR DETAIL ======== -->
182<ul class="blockList">
183<li class="blockList"><a name="constructor.detail">
184<!-- -->
185</a>
186<h3>Constructor Detail</h3>
187<a name="FileLogger-java.lang.String-">
188<!-- -->
189</a>
190<ul class="blockListLast">
191<li class="blockList">
192<h4>FileLogger</h4>
193<pre>public&nbsp;FileLogger(java.lang.String&nbsp;fileName)
194 throws java.io.FileNotFoundException</pre>
195<dl>
196<dt><span class="paramLabel">Parameters:</span></dt>
197<dd><code>fileName</code> - the log file without the .csv extension. If parent
198 directory(s) of file don't exist, they are created</dd>
199<dt><span class="throwsLabel">Throws:</span></dt>
200<dd><code>java.io.FileNotFoundException</code></dd>
201</dl>
202</li>
203</ul>
204</li>
205</ul>
206<!-- ============ METHOD DETAIL ========== -->
207<ul class="blockList">
208<li class="blockList"><a name="method.detail">
209<!-- -->
210</a>
211<h3>Method Detail</h3>
212<a name="close--">
213<!-- -->
214</a>
215<ul class="blockList">
216<li class="blockList">
217<h4>close</h4>
218<pre>public&nbsp;void&nbsp;close()
219 throws java.io.IOException</pre>
220<dl>
221<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
222<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
223<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
224<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
225<dt><span class="throwsLabel">Throws:</span></dt>
226<dd><code>java.io.IOException</code></dd>
227</dl>
228</li>
229</ul>
230<a name="notifyChange-genius.core.events.NegotiationEvent-">
231<!-- -->
232</a>
233<ul class="blockListLast">
234<li class="blockList">
235<h4>notifyChange</h4>
236<pre>public&nbsp;void&nbsp;notifyChange(<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&nbsp;e)</pre>
237<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/listener/Listener.html#notifyChange-T-">Listener</a></code></span></div>
238<div class="block">a notification call that occurs when something changed. Consult the
239 parent object for details about this event.
240
241 <h1>NOTICE 1</h1> notifications run in the thread of the caller. The
242 caller will be blocked until this callback has been completed. It is
243 therfore good practice to handle callbacks quickly.
244
245 <h1>NOTICE 2</h1> Notifications often cross a thread sarety boundary. For
246 example when in MVC a model (typically thread safe) calls back a panel
247 (not thread safe). The called side (the panel) thus must handle the
248 callback in a thread safe manner, e.g. using
249 <code>SwingUtilities.invokeLater(Runnable)</code>. We recommend to avoid
250 synchronize as this will can block indefinitely (see notice 1) which
251 might lead to deadlocks.</div>
252<dl>
253<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
254<dd><code><a href="../../../genius/core/listener/Listener.html#notifyChange-T-">notifyChange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;</code></dd>
255<dt><span class="paramLabel">Parameters:</span></dt>
256<dd><code>e</code> - additional data, typically the new value associated with the
257 event</dd>
258</dl>
259</li>
260</ul>
261</li>
262</ul>
263</li>
264</ul>
265</div>
266</div>
267<!-- ========= END OF CLASS DATA ========= -->
268<!-- ======= START OF BOTTOM NAVBAR ====== -->
269<div class="bottomNav"><a name="navbar.bottom">
270<!-- -->
271</a>
272<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
273<a name="navbar.bottom.firstrow">
274<!-- -->
275</a>
276<ul class="navList" title="Navigation">
277<li><a href="../../../overview-summary.html">Overview</a></li>
278<li><a href="package-summary.html">Package</a></li>
279<li class="navBarCell1Rev">Class</li>
280<li><a href="class-use/FileLogger.html">Use</a></li>
281<li><a href="package-tree.html">Tree</a></li>
282<li><a href="../../../deprecated-list.html">Deprecated</a></li>
283<li><a href="../../../index-all.html">Index</a></li>
284<li><a href="../../../help-doc.html">Help</a></li>
285</ul>
286</div>
287<div class="subNav">
288<ul class="navList">
289<li><a href="../../../genius/core/logging/CsvLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
290<li><a href="../../../genius/core/logging/StatisticsLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
291</ul>
292<ul class="navList">
293<li><a href="../../../index.html?genius/core/logging/FileLogger.html" target="_top">Frames</a></li>
294<li><a href="FileLogger.html" target="_top">No&nbsp;Frames</a></li>
295</ul>
296<ul class="navList" id="allclasses_navbar_bottom">
297<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
298</ul>
299<div>
300<script type="text/javascript"><!--
301 allClassesLink = document.getElementById("allclasses_navbar_bottom");
302 if(window==top) {
303 allClassesLink.style.display = "block";
304 }
305 else {
306 allClassesLink.style.display = "none";
307 }
308 //-->
309</script>
310</div>
311<div>
312<ul class="subNavList">
313<li>Summary:&nbsp;</li>
314<li>Nested&nbsp;|&nbsp;</li>
315<li>Field&nbsp;|&nbsp;</li>
316<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
317<li><a href="#method.summary">Method</a></li>
318</ul>
319<ul class="subNavList">
320<li>Detail:&nbsp;</li>
321<li>Field&nbsp;|&nbsp;</li>
322<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
323<li><a href="#method.detail">Method</a></li>
324</ul>
325</div>
326<a name="skip.navbar.bottom">
327<!-- -->
328</a></div>
329<!-- ======== END OF BOTTOM NAVBAR ======= -->
330</body>
331</html>
Note: See TracBrowser for help on using the repository browser.