forked from bjmashibing/java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConsole.html
More file actions
618 lines (615 loc) · 29.5 KB
/
Console.html
File metadata and controls
618 lines (615 loc) · 29.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Console (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.io.Console class">
<meta name="keywords" content="writer()">
<meta name="keywords" content="reader()">
<meta name="keywords" content="format()">
<meta name="keywords" content="printf()">
<meta name="keywords" content="readLine()">
<meta name="keywords" content="readPassword()">
<meta name="keywords" content="flush()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Console (Java SE 12 & JDK 12 )";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Console.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.base</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.io</a></div>
<h2 title="Class Console" class="title">Class Console</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.io.Console</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Flushable.html" title="interface in java.io">Flushable</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">Console</span>
extends <a href="../lang/Object.html" title="class in java.lang">Object</a>
implements <a href="Flushable.html" title="interface in java.io">Flushable</a></pre>
<div class="block">Methods to access the character-based console device, if any, associated
with the current Java virtual machine.
<p> Whether a virtual machine has a console is dependent upon the
underlying platform and also upon the manner in which the virtual
machine is invoked. If the virtual machine is started from an
interactive command line without redirecting the standard input and
output streams then its console will exist and will typically be
connected to the keyboard and display from which the virtual machine
was launched. If the virtual machine is started automatically, for
example by a background job scheduler, then it will typically not
have a console.
<p>
If this virtual machine has a console then it is represented by a
unique instance of this class which can be obtained by invoking the
<a href="../lang/System.html#console()"><code>System.console()</code></a> method. If no console device is
available then an invocation of that method will return <code>null</code>.
<p>
Read and write operations are synchronized to guarantee the atomic
completion of critical operations; therefore invoking methods
<a href="#readLine()"><code>readLine()</code></a>, <a href="#readPassword()"><code>readPassword()</code></a>, <a href="#format(java.lang.String,java.lang.Object...)"><code>format()</code></a>,
<a href="#printf(java.lang.String,java.lang.Object...)"><code>printf()</code></a> as well as the read, format and write operations
on the objects returned by <a href="#reader()"><code>reader()</code></a> and <a href="#writer()"><code>writer()</code></a> may
block in multithreaded scenarios.
<p>
Invoking <code>close()</code> on the objects returned by the <a href="#reader()"><code>reader()</code></a>
and the <a href="#writer()"><code>writer()</code></a> will not close the underlying stream of those
objects.
<p>
The console-read methods return <code>null</code> when the end of the
console input stream is reached, for example by typing control-D on
Unix or control-Z on Windows. Subsequent read operations will succeed
if additional characters are later entered on the console's input
device.
<p>
Unless otherwise specified, passing a <code>null</code> argument to any method
in this class will cause a <a href="../lang/NullPointerException.html" title="class in java.lang"><code>NullPointerException</code></a> to be thrown.
<p>
<b>Security note:</b>
If an application needs to read a password or other secure data, it should
use <a href="#readPassword()"><code>readPassword()</code></a> or <a href="#readPassword(java.lang.String,java.lang.Object...)"><code>readPassword(String, Object...)</code></a> and
manually zero the returned character array after processing to minimize the
lifetime of sensitive data in memory.
<blockquote><pre><code>
Console cons;
char[] passwd;
if ((cons = System.console()) != null &&
(passwd = cons.readPassword("[%s]", "Password:")) != null) {
...
java.util.Arrays.fill(passwd, ' ');
}
</code></pre></blockquote></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush()">flush</a></span>()</code></th>
<td class="colLast">
<div class="block">Flushes the console and forces any buffered output to be written
immediately .</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="Console.html" title="class in java.io">Console</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(java.lang.String,java.lang.Object...)">format</a></span>​(<a href="../lang/String.html" title="class in java.lang">String</a> fmt,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</code></th>
<td class="colLast">
<div class="block">Writes a formatted string to this console's output stream using
the specified format string and arguments.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="Console.html" title="class in java.io">Console</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#printf(java.lang.String,java.lang.Object...)">printf</a></span>​(<a href="../lang/String.html" title="class in java.lang">String</a> format,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</code></th>
<td class="colLast">
<div class="block">A convenience method to write a formatted string to this console's
output stream using the specified format string and arguments.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="Reader.html" title="class in java.io">Reader</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reader()">reader</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the unique <a href="Reader.html" title="class in java.io"><code>Reader</code></a> object associated
with this console.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readLine()">readLine</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads a single line of text from the console.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readLine(java.lang.String,java.lang.Object...)">readLine</a></span>​(<a href="../lang/String.html" title="class in java.lang">String</a> fmt,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</code></th>
<td class="colLast">
<div class="block">Provides a formatted prompt, then reads a single line of text from the
console.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>char[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readPassword()">readPassword</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads a password or passphrase from the console with echoing disabled</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>char[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readPassword(java.lang.String,java.lang.Object...)">readPassword</a></span>​(<a href="../lang/String.html" title="class in java.lang">String</a> fmt,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</code></th>
<td class="colLast">
<div class="block">Provides a formatted prompt, then reads a password or passphrase from
the console with echoing disabled.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="PrintWriter.html" title="class in java.io">PrintWriter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writer()">writer</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the unique <a href="PrintWriter.html" title="class in java.io"><code>PrintWriter</code></a> object
associated with this console.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods declared in class java.lang.<a href="../lang/Object.html" title="class in java.lang">Object</a></h3>
<code><a href="../lang/Object.html#clone()">clone</a>, <a href="../lang/Object.html#equals(java.lang.Object)">equals</a>, <a href="../lang/Object.html#finalize()">finalize</a>, <a href="../lang/Object.html#getClass()">getClass</a>, <a href="../lang/Object.html#hashCode()">hashCode</a>, <a href="../lang/Object.html#notify()">notify</a>, <a href="../lang/Object.html#notifyAll()">notifyAll</a>, <a href="../lang/Object.html#toString()">toString</a>, <a href="../lang/Object.html#wait()">wait</a>, <a href="../lang/Object.html#wait(long)">wait</a>, <a href="../lang/Object.html#wait(long,int)">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="writer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writer</h4>
<pre class="methodSignature">public <a href="PrintWriter.html" title="class in java.io">PrintWriter</a> writer()</pre>
<div class="block">Retrieves the unique <a href="PrintWriter.html" title="class in java.io"><code>PrintWriter</code></a> object
associated with this console.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The printwriter associated with this console</dd>
</dl>
</li>
</ul>
<a id="reader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reader</h4>
<pre class="methodSignature">public <a href="Reader.html" title="class in java.io">Reader</a> reader()</pre>
<div class="block">Retrieves the unique <a href="Reader.html" title="class in java.io"><code>Reader</code></a> object associated
with this console.
<p>
This method is intended to be used by sophisticated applications, for
example, a <a href="../util/Scanner.html" title="class in java.util"><code>Scanner</code></a> object which utilizes the rich
parsing/scanning functionality provided by the <code>Scanner</code>:
<blockquote><pre>
Console con = System.console();
if (con != null) {
Scanner sc = new Scanner(con.reader());
...
}
</pre></blockquote>
<p>
For simple applications requiring only line-oriented reading, use
<a href="#readLine(java.lang.String,java.lang.Object...)"><code>readLine(java.lang.String, java.lang.Object...)</code></a>.
<p>
The bulk read operations <a href="Reader.html#read(char%5B%5D)"><code>read(char[]) </code></a>,
<a href="Reader.html#read(char%5B%5D,int,int)"><code>read(char[], int, int) </code></a> and
<a href="Reader.html#read(java.nio.CharBuffer)"><code>read(java.nio.CharBuffer)</code></a>
on the returned object will not read in characters beyond the line
bound for each invocation, even if the destination buffer has space for
more characters. The <code>Reader</code>'s <code>read</code> methods may block if a
line bound has not been entered or reached on the console's input device.
A line bound is considered to be any one of a line feed (<code>'\n'</code>),
a carriage return (<code>'\r'</code>), a carriage return followed immediately
by a linefeed, or an end of stream.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The reader associated with this console</dd>
</dl>
</li>
</ul>
<a id="format(java.lang.String,java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre class="methodSignature">public <a href="Console.html" title="class in java.io">Console</a> format​(<a href="../lang/String.html" title="class in java.lang">String</a> fmt,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</pre>
<div class="block">Writes a formatted string to this console's output stream using
the specified format string and arguments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fmt</code> - A format string as described in <a href="../util/Formatter.html#syntax">Format string syntax</a></dd>
<dd><code>args</code> - Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The number of arguments is
variable and may be zero. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
<cite>The Java™ Virtual Machine Specification</cite>.
The behaviour on a
<code>null</code> argument depends on the <a href="../util/Formatter.html#syntax">conversion</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This console</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../util/IllegalFormatException.html" title="class in java.util">IllegalFormatException</a></code> - If a format string contains an illegal syntax, a format
specifier that is incompatible with the given arguments,
insufficient arguments given the format string, or other
illegal conditions. For specification of all possible
formatting errors, see the <a href="../util/Formatter.html#detail">Details</a> section
of the formatter class specification.</dd>
</dl>
</li>
</ul>
<a id="printf(java.lang.String,java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printf</h4>
<pre class="methodSignature">public <a href="Console.html" title="class in java.io">Console</a> printf​(<a href="../lang/String.html" title="class in java.lang">String</a> format,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</pre>
<div class="block">A convenience method to write a formatted string to this console's
output stream using the specified format string and arguments.
<p> An invocation of this method of the form
<code>con.printf(format, args)</code> behaves in exactly the same way
as the invocation of
<pre>con.format(format, args)</pre>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>format</code> - A format string as described in <a href="../util/Formatter.html#syntax">Format string syntax</a>.</dd>
<dd><code>args</code> - Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The number of arguments is
variable and may be zero. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
<cite>The Java™ Virtual Machine Specification</cite>.
The behaviour on a
<code>null</code> argument depends on the <a href="../util/Formatter.html#syntax">conversion</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This console</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../util/IllegalFormatException.html" title="class in java.util">IllegalFormatException</a></code> - If a format string contains an illegal syntax, a format
specifier that is incompatible with the given arguments,
insufficient arguments given the format string, or other
illegal conditions. For specification of all possible
formatting errors, see the <a href="../util/Formatter.html#detail">Details</a> section of the
formatter class specification.</dd>
</dl>
</li>
</ul>
<a id="readLine(java.lang.String,java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLine</h4>
<pre class="methodSignature">public <a href="../lang/String.html" title="class in java.lang">String</a> readLine​(<a href="../lang/String.html" title="class in java.lang">String</a> fmt,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</pre>
<div class="block">Provides a formatted prompt, then reads a single line of text from the
console.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fmt</code> - A format string as described in <a href="../util/Formatter.html#syntax">Format string syntax</a>.</dd>
<dd><code>args</code> - Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
<cite>The Java™ Virtual Machine Specification</cite>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A string containing the line read from the console, not
including any line-termination characters, or <code>null</code>
if an end of stream has been reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../util/IllegalFormatException.html" title="class in java.util">IllegalFormatException</a></code> - If a format string contains an illegal syntax, a format
specifier that is incompatible with the given arguments,
insufficient arguments given the format string, or other
illegal conditions. For specification of all possible
formatting errors, see the <a href="../util/Formatter.html#detail">Details</a> section
of the formatter class specification.</dd>
<dd><code><a href="IOError.html" title="class in java.io">IOError</a></code> - If an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLine</h4>
<pre class="methodSignature">public <a href="../lang/String.html" title="class in java.lang">String</a> readLine()</pre>
<div class="block">Reads a single line of text from the console.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A string containing the line read from the console, not
including any line-termination characters, or <code>null</code>
if an end of stream has been reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="IOError.html" title="class in java.io">IOError</a></code> - If an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readPassword(java.lang.String,java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPassword</h4>
<pre class="methodSignature">public char[] readPassword​(<a href="../lang/String.html" title="class in java.lang">String</a> fmt,
<a href="../lang/Object.html" title="class in java.lang">Object</a>... args)</pre>
<div class="block">Provides a formatted prompt, then reads a password or passphrase from
the console with echoing disabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fmt</code> - A format string as described in <a href="../util/Formatter.html#syntax">Format string syntax</a>
for the prompt text.</dd>
<dd><code>args</code> - Arguments referenced by the format specifiers in the format
string. If there are more arguments than format specifiers, the
extra arguments are ignored. The maximum number of arguments is
limited by the maximum dimension of a Java array as defined by
<cite>The Java™ Virtual Machine Specification</cite>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A character array containing the password or passphrase read
from the console, not including any line-termination characters,
or <code>null</code> if an end of stream has been reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../util/IllegalFormatException.html" title="class in java.util">IllegalFormatException</a></code> - If a format string contains an illegal syntax, a format
specifier that is incompatible with the given arguments,
insufficient arguments given the format string, or other
illegal conditions. For specification of all possible
formatting errors, see the <a href="../util/Formatter.html#detail">Details</a>
section of the formatter class specification.</dd>
<dd><code><a href="IOError.html" title="class in java.io">IOError</a></code> - If an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readPassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPassword</h4>
<pre class="methodSignature">public char[] readPassword()</pre>
<div class="block">Reads a password or passphrase from the console with echoing disabled</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A character array containing the password or passphrase read
from the console, not including any line-termination characters,
or <code>null</code> if an end of stream has been reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="IOError.html" title="class in java.io">IOError</a></code> - If an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="flush()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>flush</h4>
<pre class="methodSignature">public void flush()</pre>
<div class="block">Flushes the console and forces any buffered output to be written
immediately .</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Flushable.html#flush()">flush</a></code> in interface <code><a href="Flushable.html" title="interface in java.io">Flushable</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Console.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. <!-- Version 12.0.2+10 --></small></p>
</footer>
</body>
</html>