Projekt

Obecné

Profil

Stáhnout (17.9 KB) Statistiky
| Větev: | Tag: | Revize:

aswi2020horky-gitlab/doc/javadoc/CLI.html @ 79e3d7d7

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 
<!-- NewPage -->
3 
<html lang="cs">
4 
<head>
5 
<!-- Generated by javadoc (1.8.0_251) on Fri May 08 06:50:22 CEST 2020 -->
6 
<title>CLI</title>
7 
<meta name="date" content="2020-05-08">
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="CLI";
16 
        }
17 
    }
18 
    catch(err) {
19 
    }
20 
//-->
21 
var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":9,"i5":9,"i6":10,"i7":9};
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="class-use/CLI.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-files/index-1.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>Prev&nbsp;Class</li>
53 
<li><a href="CLI.Option.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54 
</ul>
55 
<ul class="navList">
56 
<li><a href="index.html?CLI.html" target="_top">Frames</a></li>
57 
<li><a href="CLI.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 
<h2 title="Class CLI" class="title">Class CLI</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>CLI</li>
103 
</ul>
104 
</li>
105 
</ul>
106 
<div class="description">
107 
<ul class="blockList">
108 
<li class="blockList">
109 
<dl>
110 
<dt>All Implemented Interfaces:</dt>
111 
<dd><a href="IConversionResults.html" title="interface in &lt;Unnamed&gt;">IConversionResults</a></dd>
112 
</dl>
113 
<hr>
114 
<br>
115 
<pre>public class <span class="typeNameLabel">CLI</span>
116 
extends java.lang.Object
117 
implements <a href="IConversionResults.html" title="interface in &lt;Unnamed&gt;">IConversionResults</a></pre>
118 
<div class="block">Command-line user interface.</div>
119 
</li>
120 
</ul>
121 
</div>
122 
<div class="summary">
123 
<ul class="blockList">
124 
<li class="blockList">
125 
<!-- ======== NESTED CLASS SUMMARY ======== -->
126 
<ul class="blockList">
127 
<li class="blockList"><a name="nested.class.summary">
128 
<!--   -->
129 
</a>
130 
<h3>Nested Class Summary</h3>
131 
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
132 
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
133 
<tr>
134 
<th class="colFirst" scope="col">Modifier and Type</th>
135 
<th class="colLast" scope="col">Class and Description</th>
136 
</tr>
137 
<tr class="altColor">
138 
<td class="colFirst"><code>private static class&nbsp;</code></td>
139 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.Option.html" title="class in &lt;Unnamed&gt;">CLI.Option</a></span></code>
140 
<div class="block">Instances of this class define options for running the application.</div>
141 
</td>
142 
</tr>
143 
</table>
144 
</li>
145 
</ul>
146 
<!-- =========== FIELD SUMMARY =========== -->
147 
<ul class="blockList">
148 
<li class="blockList"><a name="field.summary">
149 
<!--   -->
150 
</a>
151 
<h3>Field Summary</h3>
152 
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
153 
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
154 
<tr>
155 
<th class="colFirst" scope="col">Modifier and Type</th>
156 
<th class="colLast" scope="col">Field and Description</th>
157 
</tr>
158 
<tr class="altColor">
159 
<td class="colFirst"><code>private static java.util.HashMap&lt;<a href="CLI.Option.html" title="class in &lt;Unnamed&gt;">CLI.Option</a>,java.lang.Runnable&gt;</code></td>
160 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#options">options</a></span></code>
161 
<div class="block">The list of options for running the application.</div>
162 
</td>
163 
</tr>
164 
<tr class="rowColor">
165 
<td class="colFirst"><code>private static java.io.File</code></td>
166 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#outputFile">outputFile</a></span></code>
167 
<div class="block">Where to save the resulting JSON.</div>
168 
</td>
169 
</tr>
170 
<tr class="altColor">
171 
<td class="colFirst"><code>private static boolean</code></td>
172 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#printJSON">printJSON</a></span></code>
173 
<div class="block">Whether the resulting JSON should be written to the command line.</div>
174 
</td>
175 
</tr>
176 
</table>
177 
</li>
178 
</ul>
179 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
180 
<ul class="blockList">
181 
<li class="blockList"><a name="constructor.summary">
182 
<!--   -->
183 
</a>
184 
<h3>Constructor Summary</h3>
185 
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
186 
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
187 
<tr>
188 
<th class="colOne" scope="col">Constructor and Description</th>
189 
</tr>
190 
<tr class="altColor">
191 
<td class="colOne"><code><span class="memberNameLink"><a href="CLI.html#CLI--">CLI</a></span>()</code>&nbsp;</td>
192 
</tr>
193 
</table>
194 
</li>
195 
</ul>
196 
<!-- ========== METHOD SUMMARY =========== -->
197 
<ul class="blockList">
198 
<li class="blockList"><a name="method.summary">
199 
<!--   -->
200 
</a>
201 
<h3>Method Summary</h3>
202 
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
203 
<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>
204 
<tr>
205 
<th class="colFirst" scope="col">Modifier and Type</th>
206 
<th class="colLast" scope="col">Method and Description</th>
207 
</tr>
208 
<tr id="i0" class="altColor">
209 
<td class="colFirst"><code>void</code></td>
210 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#completed-java.lang.String-java.lang.String-">completed</a></span>(java.lang.String&nbsp;json,
211 
         java.lang.String&nbsp;loaded)</code>
212 
<div class="block">This method is used to transfer the resulting JSON to the user interface.</div>
213 
</td>
214 
</tr>
215 
<tr id="i1" class="rowColor">
216 
<td class="colFirst"><code>private static void</code></td>
217 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#errorMessage-java.lang.String-">errorMessage</a></span>(java.lang.String&nbsp;message)</code>
218 
<div class="block">Prints an error message.</div>
219 
</td>
220 
</tr>
221 
<tr id="i2" class="altColor">
222 
<td class="colFirst"><code>private static void</code></td>
223 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#help--">help</a></span>()</code>
224 
<div class="block">Prints help for running the application.</div>
225 
</td>
226 
</tr>
227 
<tr id="i3" class="rowColor">
228 
<td class="colFirst"><code>void</code></td>
229 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#loadingInputFileError--">loadingInputFileError</a></span>()</code>
230 
<div class="block">This method is used when an input read error occurs.</div>
231 
</td>
232 
</tr>
233 
<tr id="i4" class="altColor">
234 
<td class="colFirst"><code>static void</code></td>
235 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>
236 
<div class="block">Main method.</div>
237 
</td>
238 
</tr>
239 
<tr id="i5" class="rowColor">
240 
<td class="colFirst"><code>private static java.lang.String</code></td>
241 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#printOptions--">printOptions</a></span>()</code>&nbsp;</td>
242 
</tr>
243 
<tr id="i6" class="altColor">
244 
<td class="colFirst"><code>private void</code></td>
245 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#saveJson-java.lang.String-">saveJson</a></span>(java.lang.String&nbsp;json)</code>
246 
<div class="block">Saves the resulting text (JSON) to the file or prints it to the command line.</div>
247 
</td>
248 
</tr>
249 
<tr id="i7" class="rowColor">
250 
<td class="colFirst"><code>private static void</code></td>
251 
<td class="colLast"><code><span class="memberNameLink"><a href="CLI.html#setPrintJSON--">setPrintJSON</a></span>()</code>
252 
<div class="block">Sets printJSON to true.</div>
253 
</td>
254 
</tr>
255 
</table>
256 
<ul class="blockList">
257 
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
258 
<!--   -->
259 
</a>
260 
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
261 
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
262 
</ul>
263 
</li>
264 
</ul>
265 
</li>
266 
</ul>
267 
</div>
268 
<div class="details">
269 
<ul class="blockList">
270 
<li class="blockList">
271 
<!-- ============ FIELD DETAIL =========== -->
272 
<ul class="blockList">
273 
<li class="blockList"><a name="field.detail">
274 
<!--   -->
275 
</a>
276 
<h3>Field Detail</h3>
277 
<a name="options">
278 
<!--   -->
279 
</a>
280 
<ul class="blockList">
281 
<li class="blockList">
282 
<h4>options</h4>
283 
<pre>private static&nbsp;java.util.HashMap&lt;<a href="CLI.Option.html" title="class in &lt;Unnamed&gt;">CLI.Option</a>,java.lang.Runnable&gt; options</pre>
284 
<div class="block">The list of options for running the application.</div>
285 
</li>
286 
</ul>
287 
<a name="printJSON">
288 
<!--   -->
289 
</a>
290 
<ul class="blockList">
291 
<li class="blockList">
292 
<h4>printJSON</h4>
293 
<pre>private static&nbsp;boolean printJSON</pre>
294 
<div class="block">Whether the resulting JSON should be written to the command line.</div>
295 
</li>
296 
</ul>
297 
<a name="outputFile">
298 
<!--   -->
299 
</a>
300 
<ul class="blockListLast">
301 
<li class="blockList">
302 
<h4>outputFile</h4>
303 
<pre>private static&nbsp;java.io.File outputFile</pre>
304 
<div class="block">Where to save the resulting JSON.</div>
305 
</li>
306 
</ul>
307 
</li>
308 
</ul>
309 
<!-- ========= CONSTRUCTOR DETAIL ======== -->
310 
<ul class="blockList">
311 
<li class="blockList"><a name="constructor.detail">
312 
<!--   -->
313 
</a>
314 
<h3>Constructor Detail</h3>
315 
<a name="CLI--">
316 
<!--   -->
317 
</a>
318 
<ul class="blockListLast">
319 
<li class="blockList">
320 
<h4>CLI</h4>
321 
<pre>public&nbsp;CLI()</pre>
322 
</li>
323 
</ul>
324 
</li>
325 
</ul>
326 
<!-- ============ METHOD DETAIL ========== -->
327 
<ul class="blockList">
328 
<li class="blockList"><a name="method.detail">
329 
<!--   -->
330 
</a>
331 
<h3>Method Detail</h3>
332 
<a name="help--">
333 
<!--   -->
334 
</a>
335 
<ul class="blockList">
336 
<li class="blockList">
337 
<h4>help</h4>
338 
<pre>private static&nbsp;void&nbsp;help()</pre>
339 
<div class="block">Prints help for running the application.</div>
340 
</li>
341 
</ul>
342 
<a name="setPrintJSON--">
343 
<!--   -->
344 
</a>
345 
<ul class="blockList">
346 
<li class="blockList">
347 
<h4>setPrintJSON</h4>
348 
<pre>private static&nbsp;void&nbsp;setPrintJSON()</pre>
349 
<div class="block">Sets printJSON to true.</div>
350 
</li>
351 
</ul>
352 
<a name="printOptions--">
353 
<!--   -->
354 
</a>
355 
<ul class="blockList">
356 
<li class="blockList">
357 
<h4>printOptions</h4>
358 
<pre>private static&nbsp;java.lang.String&nbsp;printOptions()</pre>
359 
<dl>
360 
<dt><span class="returnLabel">Returns:</span></dt>
361 
<dd>string with all possible options for running the application.</dd>
362 
</dl>
363 
</li>
364 
</ul>
365 
<a name="main-java.lang.String:A-">
366 
<!--   -->
367 
</a>
368 
<ul class="blockList">
369 
<li class="blockList">
370 
<h4>main</h4>
371 
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)</pre>
372 
<div class="block">Main method.</div>
373 
<dl>
374 
<dt><span class="paramLabel">Parameters:</span></dt>
375 
<dd><code>args</code> - input arguments.</dd>
376 
</dl>
377 
</li>
378 
</ul>
379 
<a name="errorMessage-java.lang.String-">
380 
<!--   -->
381 
</a>
382 
<ul class="blockList">
383 
<li class="blockList">
384 
<h4>errorMessage</h4>
385 
<pre>private static&nbsp;void&nbsp;errorMessage(java.lang.String&nbsp;message)</pre>
386 
<div class="block">Prints an error message.</div>
387 
<dl>
388 
<dt><span class="paramLabel">Parameters:</span></dt>
389 
<dd><code>message</code> - error message.</dd>
390 
</dl>
391 
</li>
392 
</ul>
393 
<a name="loadingInputFileError--">
394 
<!--   -->
395 
</a>
396 
<ul class="blockList">
397 
<li class="blockList">
398 
<h4>loadingInputFileError</h4>
399 
<pre>public&nbsp;void&nbsp;loadingInputFileError()</pre>
400 
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IConversionResults.html#loadingInputFileError--">IConversionResults</a></code></span></div>
401 
<div class="block">This method is used when an input read error occurs.</div>
402 
<dl>
403 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
404 
<dd><code><a href="IConversionResults.html#loadingInputFileError--">loadingInputFileError</a></code>&nbsp;in interface&nbsp;<code><a href="IConversionResults.html" title="interface in &lt;Unnamed&gt;">IConversionResults</a></code></dd>
405 
</dl>
406 
</li>
407 
</ul>
408 
<a name="completed-java.lang.String-java.lang.String-">
409 
<!--   -->
410 
</a>
411 
<ul class="blockList">
412 
<li class="blockList">
413 
<h4>completed</h4>
414 
<pre>public&nbsp;void&nbsp;completed(java.lang.String&nbsp;json,
415 
                      java.lang.String&nbsp;loaded)</pre>
416 
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="IConversionResults.html#completed-java.lang.String-java.lang.String-">IConversionResults</a></code></span></div>
417 
<div class="block">This method is used to transfer the resulting JSON to the user interface. It
418 
 also transmits the extracted input content (file, query).</div>
419 
<dl>
420 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
421 
<dd><code><a href="IConversionResults.html#completed-java.lang.String-java.lang.String-">completed</a></code>&nbsp;in interface&nbsp;<code><a href="IConversionResults.html" title="interface in &lt;Unnamed&gt;">IConversionResults</a></code></dd>
422 
<dt><span class="paramLabel">Parameters:</span></dt>
423 
<dd><code>json</code> - the resulting JSON. It is null when a jdeserialize error
424 
               occurs.</dd>
425 
<dd><code>loaded</code> - extracted input content. It is null if an input read error
426 
               occurs.</dd>
427 
</dl>
428 
</li>
429 
</ul>
430 
<a name="saveJson-java.lang.String-">
431 
<!--   -->
432 
</a>
433 
<ul class="blockListLast">
434 
<li class="blockList">
435 
<h4>saveJson</h4>
436 
<pre>private&nbsp;void&nbsp;saveJson(java.lang.String&nbsp;json)</pre>
437 
<div class="block">Saves the resulting text (JSON) to the file or prints it to the command line.</div>
438 
<dl>
439 
<dt><span class="paramLabel">Parameters:</span></dt>
440 
<dd><code>json</code> - the resulting text in JSON format.</dd>
441 
</dl>
442 
</li>
443 
</ul>
444 
</li>
445 
</ul>
446 
</li>
447 
</ul>
448 
</div>
449 
</div>
450 
<!-- ========= END OF CLASS DATA ========= -->
451 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
452 
<div class="bottomNav"><a name="navbar.bottom">
453 
<!--   -->
454 
</a>
455 
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
456 
<a name="navbar.bottom.firstrow">
457 
<!--   -->
458 
</a>
459 
<ul class="navList" title="Navigation">
460 
<li><a href="overview-summary.html">Overview</a></li>
461 
<li><a href="package-summary.html">Package</a></li>
462 
<li class="navBarCell1Rev">Class</li>
463 
<li><a href="class-use/CLI.html">Use</a></li>
464 
<li><a href="package-tree.html">Tree</a></li>
465 
<li><a href="deprecated-list.html">Deprecated</a></li>
466 
<li><a href="index-files/index-1.html">Index</a></li>
467 
<li><a href="help-doc.html">Help</a></li>
468 
</ul>
469 
</div>
470 
<div class="subNav">
471 
<ul class="navList">
472 
<li>Prev&nbsp;Class</li>
473 
<li><a href="CLI.Option.html" title="class in &lt;Unnamed&gt;"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
474 
</ul>
475 
<ul class="navList">
476 
<li><a href="index.html?CLI.html" target="_top">Frames</a></li>
477 
<li><a href="CLI.html" target="_top">No&nbsp;Frames</a></li>
478 
</ul>
479 
<ul class="navList" id="allclasses_navbar_bottom">
480 
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
481 
</ul>
482 
<div>
483 
<script type="text/javascript"><!--
484 
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
485 
  if(window==top) {
486 
    allClassesLink.style.display = "block";
487 
  }
488 
  else {
489 
    allClassesLink.style.display = "none";
490 
  }
491 
  //-->
492 
</script>
493 
</div>
494 
<div>
495 
<ul class="subNavList">
496 
<li>Summary:&nbsp;</li>
497 
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
498 
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
499 
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
500 
<li><a href="#method.summary">Method</a></li>
501 
</ul>
502 
<ul class="subNavList">
503 
<li>Detail:&nbsp;</li>
504 
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
505 
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
506 
<li><a href="#method.detail">Method</a></li>
507 
</ul>
508 
</div>
509 
<a name="skip.navbar.bottom">
510 
<!--   -->
511 
</a></div>
512 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
513 
</body>
514 
</html>
(2-2/24)