Java Doc for Console.java in  » 6.0-JDK-Core » io-nio » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.Console

Console
final public class Console implements Flushable(Code)
Methods to access the character-based console device, if any, associated with the current Java virtual machine.

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.

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 java.lang.System.console method. If no console device is available then an invocation of that method will return null.

Read and write operations are synchronized to guarantee the atomic completion of critical operations; therefore invoking methods Console.readLine() , Console.readPassword() , Console.format format() , Console.printf printf() as well as the read, format and write operations on the objects returned by Console.reader() and Console.writer() may block in multithreaded scenarios.

Invoking close() on the objects returned by the Console.reader() and the Console.writer() will not close the underlying stream of those objects.

The console-read methods return null 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.

Unless otherwise specified, passing a null argument to any method in this class will cause a NullPointerException to be thrown.

Security note: If an application needs to read a password or other secure data, it should use Console.readPassword() or Console.readPassword(String,Object) and manually zero the returned character array after processing to minimize the lifetime of sensitive data in memory.

 Console cons;
 char[] passwd;
 if ((cons = System.console()) != null &&
 (passwd = cons.readPassword("[%s]", "Password:")) != null) {
 ...
 java.util.Arrays.fill(passwd, ' ');
 }
 

author:
   Xueming Shen
version:
   1.17, 05/05/07
since:
   1.6

Inner Class :class LineReader extends Reader



Method Summary
public  voidflush()
     Flushes the console and forces any buffered output to be written immediately .
public  Consoleformat(String fmt, Object... args)
     Writes a formatted string to this console's output stream using the specified format string and arguments.
Parameters:
  fmt - A format string as described in Format string syntax
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring.
public  Consoleprintf(String format, Object... args)
     A convenience method to write a formatted string to this console's output stream using the specified format string and arguments.

An invocation of this method of the form con.printf(format, args) behaves in exactly the same way as the invocation of

con.format(format, args)
.
Parameters:
  format - A format string as described in Format string syntax.
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring.
public  StringreadLine(String fmt, Object... args)
     Provides a formatted prompt, then reads a single line of text from the console.
Parameters:
  fmt - A format string as described in Format string syntax.
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring.
public  StringreadLine()
     Reads a single line of text from the console.
throws:
  IOError - If an I/O error occurs.
public  char[]readPassword(String fmt, Object... args)
     Provides a formatted prompt, then reads a password or passphrase from the console with echoing disabled.
Parameters:
  fmt - A format string as described in Format string syntaxfor the prompt text.
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring.
public  char[]readPassword()
     Reads a password or passphrase from the console with echoing disabled
throws:
  IOError - If an I/O error occurs.
public  Readerreader()
     Retrieves the unique java.io.Reader Reader object associated with this console.

This method is intended to be used by sophisticated applications, for example, a java.util.Scanner object which utilizes the rich parsing/scanning functionality provided by the Scanner:

 Console con = System.console();
 if (con != null) {
 Scanner sc = new Scanner(con.reader());
 ...
 }
 

For simple applications requiring only line-oriented reading, use Console.readLine .

The bulk read operations java.io.Reader.read(char[]) read(char[]) , java.io.Reader.read(char[]intint) read(char[], int, int) and java.io.Reader.read(java.nio.CharBuffer) read(java.nio.CharBuffer) 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.

public  PrintWriterwriter()
     Retrieves the unique java.io.PrintWriter PrintWriter object associated with this console.



Method Detail
flush
public void flush()(Code)
Flushes the console and forces any buffered output to be written immediately .



format
public Console format(String fmt, Object... args)(Code)
Writes a formatted string to this console's output stream using the specified format string and arguments.
Parameters:
  fmt - A format string as described in Format string syntax
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion.
throws:
  IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details sectionof the formatter class specification. This console



printf
public Console printf(String format, Object... args)(Code)
A convenience method to write a formatted string to this console's output stream using the specified format string and arguments.

An invocation of this method of the form con.printf(format, args) behaves in exactly the same way as the invocation of

con.format(format, args)
.
Parameters:
  format - A format string as described in Format string syntax.
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion.
throws:
  IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theformatter class specification. This console



readLine
public String readLine(String fmt, Object... args)(Code)
Provides a formatted prompt, then reads a single line of text from the console.
Parameters:
  fmt - A format string as described in Format string syntax.
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification.
throws:
  IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details sectionof the formatter class specification.
throws:
  IOError - If an I/O error occurs. A string containing the line read from the console, notincluding any line-termination characters, or nullif an end of stream has been reached.



readLine
public String readLine()(Code)
Reads a single line of text from the console.
throws:
  IOError - If an I/O error occurs. A string containing the line read from the console, notincluding any line-termination characters, or nullif an end of stream has been reached.



readPassword
public char[] readPassword(String fmt, Object... args)(Code)
Provides a formatted prompt, then reads a password or passphrase from the console with echoing disabled.
Parameters:
  fmt - A format string as described in Format string syntaxfor the prompt text.
Parameters:
  args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification.
throws:
  IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Detailssection of the formatter class specification.
throws:
  IOError - If an I/O error occurs. A character array containing the password or passphrase readfrom the console, not including any line-termination characters,or null if an end of stream has been reached.



readPassword
public char[] readPassword()(Code)
Reads a password or passphrase from the console with echoing disabled
throws:
  IOError - If an I/O error occurs. A character array containing the password or passphrase readfrom the console, not including any line-termination characters,or null if an end of stream has been reached.



reader
public Reader reader()(Code)
Retrieves the unique java.io.Reader Reader object associated with this console.

This method is intended to be used by sophisticated applications, for example, a java.util.Scanner object which utilizes the rich parsing/scanning functionality provided by the Scanner:

 Console con = System.console();
 if (con != null) {
 Scanner sc = new Scanner(con.reader());
 ...
 }
 

For simple applications requiring only line-oriented reading, use Console.readLine .

The bulk read operations java.io.Reader.read(char[]) read(char[]) , java.io.Reader.read(char[]intint) read(char[], int, int) and java.io.Reader.read(java.nio.CharBuffer) read(java.nio.CharBuffer) 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. A line bound is considered to be any one of a line feed ('\n'), a carriage return ('\r'), a carriage return followed immediately by a linefeed, or an end of stream. The reader associated with this console




writer
public PrintWriter writer()(Code)
Retrieves the unique java.io.PrintWriter PrintWriter object associated with this console. The printwriter associated with this console



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.