source: javadoc/genius/core/exceptions/Warning.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: 15.8 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:56 CEST 2018 -->
6<title>Warning (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="Warning (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":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/Warning.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/exceptions/NegotiatorException.html" title="class in genius.core.exceptions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/exceptions/Warning.MyWarningException.html" title="class in genius.core.exceptions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/exceptions/Warning.html" target="_top">Frames</a></li>
57<li><a href="Warning.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
78<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.exceptions</div>
96<h2 title="Class Warning" class="title">Class Warning</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.exceptions.Warning</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<hr>
111<br>
112<pre>public class <span class="typeNameLabel">Warning</span>
113extends java.lang.Object</pre>
114<div class="block">Warning objects handle warning messages. These objects also count how many
115 times a particular type of message has been issued already. You can ask for a
116 stack dump as well.</div>
117</li>
118</ul>
119</div>
120<div class="summary">
121<ul class="blockList">
122<li class="blockList">
123<!-- ======== NESTED CLASS SUMMARY ======== -->
124<ul class="blockList">
125<li class="blockList"><a name="nested.class.summary">
126<!-- -->
127</a>
128<h3>Nested Class Summary</h3>
129<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
130<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
131<tr>
132<th class="colFirst" scope="col">Modifier and Type</th>
133<th class="colLast" scope="col">Class and Description</th>
134</tr>
135<tr class="altColor">
136<td class="colFirst"><code>protected class&nbsp;</code></td>
137<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.MyWarningException.html" title="class in genius.core.exceptions">Warning.MyWarningException</a></span></code>&nbsp;</td>
138</tr>
139</table>
140</li>
141</ul>
142<!-- =========== FIELD SUMMARY =========== -->
143<ul class="blockList">
144<li class="blockList"><a name="field.summary">
145<!-- -->
146</a>
147<h3>Field Summary</h3>
148<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
149<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
150<tr>
151<th class="colFirst" scope="col">Modifier and Type</th>
152<th class="colLast" scope="col">Field and Description</th>
153</tr>
154<tr class="altColor">
155<td class="colFirst"><code>static int</code></td>
156<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.html#DEFAULT_SUPPRESSION_NUMBER">DEFAULT_SUPPRESSION_NUMBER</a></span></code>&nbsp;</td>
157</tr>
158</table>
159</li>
160</ul>
161<!-- ======== CONSTRUCTOR SUMMARY ======== -->
162<ul class="blockList">
163<li class="blockList"><a name="constructor.summary">
164<!-- -->
165</a>
166<h3>Constructor Summary</h3>
167<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
168<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
169<tr>
170<th class="colOne" scope="col">Constructor and Description</th>
171</tr>
172<tr class="altColor">
173<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.html#Warning-java.lang.String-">Warning</a></span>(java.lang.String&nbsp;warning)</code>
174<div class="block">Default warning: Print warning message at most 5 times.</div>
175</td>
176</tr>
177<tr class="rowColor">
178<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.html#Warning-java.lang.String-boolean-int-">Warning</a></span>(java.lang.String&nbsp;warning,
179 boolean&nbsp;showstack,
180 int&nbsp;suppressat)</code>
181<div class="block">The location of the error will be reported as the code location where
182 this warning is placed.</div>
183</td>
184</tr>
185<tr class="altColor">
186<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.html#Warning-java.lang.String-java.lang.Exception-">Warning</a></span>(java.lang.String&nbsp;pWarning,
187 java.lang.Exception&nbsp;err)</code>&nbsp;</td>
188</tr>
189<tr class="rowColor">
190<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.html#Warning-java.lang.String-java.lang.Exception-boolean-int-">Warning</a></span>(java.lang.String&nbsp;pWarning,
191 java.lang.Exception&nbsp;err,
192 boolean&nbsp;pShowStack,
193 int&nbsp;pSuppressAt)</code>
194<div class="block">Note that this is not useful if you are converting an exception into a
195 warning.</div>
196</td>
197</tr>
198</table>
199</li>
200</ul>
201<!-- ========== METHOD SUMMARY =========== -->
202<ul class="blockList">
203<li class="blockList"><a name="method.summary">
204<!-- -->
205</a>
206<h3>Method Summary</h3>
207<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
208<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>
209<tr>
210<th class="colFirst" scope="col">Modifier and Type</th>
211<th class="colLast" scope="col">Method and Description</th>
212</tr>
213<tr id="i0" class="altColor">
214<td class="colFirst"><code>void</code></td>
215<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/exceptions/Warning.html#makeWarning-java.lang.String-java.lang.Exception-boolean-int-">makeWarning</a></span>(java.lang.String&nbsp;pWarning,
216 java.lang.Exception&nbsp;e,
217 boolean&nbsp;pDumpStack,
218 int&nbsp;pSuppressAt)</code>
219<div class="block">Add warning to static hashtable used to keep track of all warnings issued
220 so far.</div>
221</td>
222</tr>
223</table>
224<ul class="blockList">
225<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
226<!-- -->
227</a>
228<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
229<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
230</ul>
231</li>
232</ul>
233</li>
234</ul>
235</div>
236<div class="details">
237<ul class="blockList">
238<li class="blockList">
239<!-- ============ FIELD DETAIL =========== -->
240<ul class="blockList">
241<li class="blockList"><a name="field.detail">
242<!-- -->
243</a>
244<h3>Field Detail</h3>
245<a name="DEFAULT_SUPPRESSION_NUMBER">
246<!-- -->
247</a>
248<ul class="blockListLast">
249<li class="blockList">
250<h4>DEFAULT_SUPPRESSION_NUMBER</h4>
251<pre>public static final&nbsp;int DEFAULT_SUPPRESSION_NUMBER</pre>
252<dl>
253<dt><span class="seeLabel">See Also:</span></dt>
254<dd><a href="../../../constant-values.html#genius.core.exceptions.Warning.DEFAULT_SUPPRESSION_NUMBER">Constant Field Values</a></dd>
255</dl>
256</li>
257</ul>
258</li>
259</ul>
260<!-- ========= CONSTRUCTOR DETAIL ======== -->
261<ul class="blockList">
262<li class="blockList"><a name="constructor.detail">
263<!-- -->
264</a>
265<h3>Constructor Detail</h3>
266<a name="Warning-java.lang.String-">
267<!-- -->
268</a>
269<ul class="blockList">
270<li class="blockList">
271<h4>Warning</h4>
272<pre>public&nbsp;Warning(java.lang.String&nbsp;warning)</pre>
273<div class="block">Default warning: Print warning message at most 5 times. Stack trace is
274 not printed.</div>
275</li>
276</ul>
277<a name="Warning-java.lang.String-boolean-int-">
278<!-- -->
279</a>
280<ul class="blockList">
281<li class="blockList">
282<h4>Warning</h4>
283<pre>public&nbsp;Warning(java.lang.String&nbsp;warning,
284 boolean&nbsp;showstack,
285 int&nbsp;suppressat)</pre>
286<div class="block">The location of the error will be reported as the code location where
287 this warning is placed. Note that this is not useful if you are
288 converting an exception into a warning. In that case, you better use
289 Warning(warning, Exception).</div>
290<dl>
291<dt><span class="paramLabel">Parameters:</span></dt>
292<dd><code>warning</code> - is the message to be shown</dd>
293<dd><code>showstack</code> - is true if you want to show a stack dump as well. Then, stack
294 dump will be made for location where WARNING occurs</dd>
295<dd><code>suppressat</code> - is the maximum number of this warning you want to appear</dd>
296</dl>
297</li>
298</ul>
299<a name="Warning-java.lang.String-java.lang.Exception-">
300<!-- -->
301</a>
302<ul class="blockList">
303<li class="blockList">
304<h4>Warning</h4>
305<pre>public&nbsp;Warning(java.lang.String&nbsp;pWarning,
306 java.lang.Exception&nbsp;err)</pre>
307</li>
308</ul>
309<a name="Warning-java.lang.String-java.lang.Exception-boolean-int-">
310<!-- -->
311</a>
312<ul class="blockListLast">
313<li class="blockList">
314<h4>Warning</h4>
315<pre>public&nbsp;Warning(java.lang.String&nbsp;pWarning,
316 java.lang.Exception&nbsp;err,
317 boolean&nbsp;pShowStack,
318 int&nbsp;pSuppressAt)</pre>
319<div class="block">Note that this is not useful if you are converting an exception into a
320 warning. In that case, you better use Warning(warning, Exception)</div>
321<dl>
322<dt><span class="paramLabel">Parameters:</span></dt>
323<dd><code>pWarning</code> - is the message to be shown</dd>
324<dd><code>err</code> - is the exception that caused the rise of this warning. this
325 will be used to inform the user about where the problem
326 occured.</dd>
327<dd><code>pShowStack</code> - is true if you want to show a stack dump as well. If set,
328 stack dump will be made for location where WARNING occurs.</dd>
329<dd><code>pSuppressAt</code> - is the maximum number of this warning you want to appear</dd>
330</dl>
331</li>
332</ul>
333</li>
334</ul>
335<!-- ============ METHOD DETAIL ========== -->
336<ul class="blockList">
337<li class="blockList"><a name="method.detail">
338<!-- -->
339</a>
340<h3>Method Detail</h3>
341<a name="makeWarning-java.lang.String-java.lang.Exception-boolean-int-">
342<!-- -->
343</a>
344<ul class="blockListLast">
345<li class="blockList">
346<h4>makeWarning</h4>
347<pre>public&nbsp;void&nbsp;makeWarning(java.lang.String&nbsp;pWarning,
348 java.lang.Exception&nbsp;e,
349 boolean&nbsp;pDumpStack,
350 int&nbsp;pSuppressAt)</pre>
351<div class="block">Add warning to static hashtable used to keep track of all warnings issued
352 so far. Only show warning if message has not appeared more than
353 'fSuppressAt' times.</div>
354<dl>
355<dt><span class="paramLabel">Parameters:</span></dt>
356<dd><code>e</code> - is exception that caused the problem. Use null to avoid stack
357 dump.</dd>
358</dl>
359</li>
360</ul>
361</li>
362</ul>
363</li>
364</ul>
365</div>
366</div>
367<!-- ========= END OF CLASS DATA ========= -->
368<!-- ======= START OF BOTTOM NAVBAR ====== -->
369<div class="bottomNav"><a name="navbar.bottom">
370<!-- -->
371</a>
372<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
373<a name="navbar.bottom.firstrow">
374<!-- -->
375</a>
376<ul class="navList" title="Navigation">
377<li><a href="../../../overview-summary.html">Overview</a></li>
378<li><a href="package-summary.html">Package</a></li>
379<li class="navBarCell1Rev">Class</li>
380<li><a href="class-use/Warning.html">Use</a></li>
381<li><a href="package-tree.html">Tree</a></li>
382<li><a href="../../../deprecated-list.html">Deprecated</a></li>
383<li><a href="../../../index-all.html">Index</a></li>
384<li><a href="../../../help-doc.html">Help</a></li>
385</ul>
386</div>
387<div class="subNav">
388<ul class="navList">
389<li><a href="../../../genius/core/exceptions/NegotiatorException.html" title="class in genius.core.exceptions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
390<li><a href="../../../genius/core/exceptions/Warning.MyWarningException.html" title="class in genius.core.exceptions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
391</ul>
392<ul class="navList">
393<li><a href="../../../index.html?genius/core/exceptions/Warning.html" target="_top">Frames</a></li>
394<li><a href="Warning.html" target="_top">No&nbsp;Frames</a></li>
395</ul>
396<ul class="navList" id="allclasses_navbar_bottom">
397<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
398</ul>
399<div>
400<script type="text/javascript"><!--
401 allClassesLink = document.getElementById("allclasses_navbar_bottom");
402 if(window==top) {
403 allClassesLink.style.display = "block";
404 }
405 else {
406 allClassesLink.style.display = "none";
407 }
408 //-->
409</script>
410</div>
411<div>
412<ul class="subNavList">
413<li>Summary:&nbsp;</li>
414<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
415<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
416<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
417<li><a href="#method.summary">Method</a></li>
418</ul>
419<ul class="subNavList">
420<li>Detail:&nbsp;</li>
421<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
422<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
423<li><a href="#method.detail">Method</a></li>
424</ul>
425</div>
426<a name="skip.navbar.bottom">
427<!-- -->
428</a></div>
429<!-- ======== END OF BOTTOM NAVBAR ======= -->
430</body>
431</html>
Note: See TracBrowser for help on using the repository browser.