java.io
Class PrintStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--java.io.FilterOutputStream
              |
              +--java.io.PrintStream

public class PrintStream
extends FilterOutputStream

Untamed:


Field Summary
private  boolean autoFlush
           
private  OutputStreamWriter charOut
           
private  boolean closing
           
private  BufferedWriter textOut
          Track both the text- and character-output streams, so that their buffers can be flushed without flushing the entire stream.
private  boolean trouble
           
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary
private PrintStream(boolean autoFlush, OutputStream out)
           
  PrintStream(OutputStream out)
          Enabled: Create a new print stream.
  PrintStream(OutputStream out, boolean autoFlush)
          Enabled: Create a new print stream.
  PrintStream(OutputStream out, boolean autoFlush, String encoding)
          Enabled: Create a new print stream.
 
Method Summary
 boolean checkError()
          Enabled: Flush the stream and check its error state.
 void close()
          Enabled: Close the stream.
private  void ensureOpen()
          Check to make sure that the stream has not been closed
 void flush()
          Enabled: Flush the stream.
private  void init(OutputStreamWriter osw)
           
private  void newLine()
           
 void print(boolean b)
          Enabled: Print a boolean value.
 void print(char c)
          Enabled: Print a character.
 void print(char[] s)
          Enabled: Print an array of characters.
 void print(double d)
          Enabled: Print a double-precision floating-point number.
 void print(float f)
          Enabled: Print a floating-point number.
 void print(int i)
          Enabled: Print an integer.
 void print(long l)
          Enabled: Print a long integer.
 void print(Object obj)
          Enabled: Print an object.
 void print(String s)
          Enabled: Print a string.
 void println()
          Enabled: Terminate the current line by writing the line separator string.
 void println(boolean x)
          Enabled: Print a boolean and then terminate the line.
 void println(char x)
          Enabled: Print a character and then terminate the line.
 void println(char[] x)
          Enabled: Print an array of characters and then terminate the line.
 void println(double x)
          Enabled: Print a double and then terminate the line.
 void println(float x)
          Enabled: Print a float and then terminate the line.
 void println(int x)
          Enabled: Print an integer and then terminate the line.
 void println(long x)
          Enabled: Print a long and then terminate the line.
 void println(Object x)
          Enabled: Print an Object and then terminate the line.
 void println(String x)
          Enabled: Print a String and then terminate the line.
protected  void setError()
          Set the error state of the stream to true.
 void write(byte[] buf, int off, int len)
          Enabled: Write len bytes from the specified byte array starting at offset off to this stream.
private  void write(char[] buf)
           
 void write(int b)
          Enabled: Write the specified byte to this stream.
private  void write(String s)
           
 
Methods inherited from class java.io.FilterOutputStream
write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

autoFlush

private boolean autoFlush

trouble

private boolean trouble

textOut

private BufferedWriter textOut
Track both the text- and character-output streams, so that their buffers can be flushed without flushing the entire stream.


charOut

private OutputStreamWriter charOut

closing

private boolean closing
Constructor Detail

PrintStream

public PrintStream(OutputStream out)
Enabled: Create a new print stream. This stream will not flush automatically.

Parameters:
out - The output stream to which values and objects will be printed
See Also:
java.io.PrintWriter#PrintWriter(java.io.OutputStream)

PrintStream

private PrintStream(boolean autoFlush,
                    OutputStream out)

PrintStream

public PrintStream(OutputStream out,
                   boolean autoFlush)
Enabled: Create a new print stream.

Parameters:
out - The output stream to which values and objects will be printed
autoFlush - A boolean; if true, the output buffer will be flushed whenever a byte array is written, one of the println methods is invoked, or a newline character or byte ('\n') is written
See Also:
java.io.PrintWriter#PrintWriter(java.io.OutputStream, boolean)

PrintStream

public PrintStream(OutputStream out,
                   boolean autoFlush,
                   String encoding)
            throws UnsupportedEncodingException
Enabled: Create a new print stream.

Parameters:
out - The output stream to which values and objects will be printed
autoFlush - A boolean; if true, the output buffer will be flushed whenever a byte array is written, one of the println methods is invoked, or a newline character or byte ('\n') is written
encoding - The name of a supported character encoding
Method Detail

init

private void init(OutputStreamWriter osw)

ensureOpen

private void ensureOpen()
                 throws IOException
Check to make sure that the stream has not been closed

IOException

flush

public void flush()
Enabled: Flush the stream. This is done by writing any buffered output bytes to the underlying output stream and then flushing that stream.

Overrides:
flush in class FilterOutputStream
See Also:
java.io.OutputStream#flush()

close

public void close()
Enabled: Close the stream. This is done by flushing the stream and then closing the underlying output stream.

Overrides:
close in class FilterOutputStream
See Also:
java.io.OutputStream#close()

checkError

public boolean checkError()
Enabled: Flush the stream and check its error state. The internal error state is set to true when the underlying output stream throws an IOException other than InterruptedIOException, and when the setError method is invoked. If an operation on the underlying output stream throws an InterruptedIOException, then the PrintStream converts the exception back into an interrupt by doing:
     Thread.currentThread().interrupt();
 
or the equivalent.

Returns:
True if and only if this stream has encountered an IOException other than InterruptedIOException, or the setError method has been invoked

setError

protected void setError()
Set the error state of the stream to true.

Since:
JDK1.1

write

public void write(int b)
Enabled: Write the specified byte to this stream. If the byte is a newline and automatic flushing is enabled then the flush method will be invoked.

Note that the byte is written as given; to write a character that will be translated according to the platform's default character encoding, use the print(char) or println(char) methods.

Overrides:
write in class FilterOutputStream
Parameters:
b - The byte to be written
See Also:
print(char), println(char)

write

public void write(byte[] buf,
                  int off,
                  int len)
Enabled: Write len bytes from the specified byte array starting at offset off to this stream. If automatic flushing is enabled then the flush method will be invoked.

Note that the bytes will be written as given; to write characters that will be translated according to the platform's default character encoding, use the print(char) or println(char) methods.

Overrides:
write in class FilterOutputStream
Parameters:
buf - A byte array
off - Offset from which to start taking bytes
len - Number of bytes to write
See Also:
java.io.FilterOutputStream#write(int)

write

private void write(char[] buf)

write

private void write(String s)

newLine

private void newLine()

print

public void print(boolean b)
Enabled: Print a boolean value. The string produced by java.lang.String#valueOf(boolean) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
b - The boolean to be printed

print

public void print(char c)
Enabled: Print a character. The character is translated into one or more bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
c - The char to be printed

print

public void print(int i)
Enabled: Print an integer. The string produced by java.lang.String#valueOf(int) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
i - The int to be printed
See Also:
java.lang.Integer#toString(int)

print

public void print(long l)
Enabled: Print a long integer. The string produced by java.lang.String#valueOf(long) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
l - The long to be printed
See Also:
java.lang.Long#toString(long)

print

public void print(float f)
Enabled: Print a floating-point number. The string produced by java.lang.String#valueOf(float) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
f - The float to be printed
See Also:
java.lang.Float#toString(float)

print

public void print(double d)
Enabled: Print a double-precision floating-point number. The string produced by java.lang.String#valueOf(double) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
d - The double to be printed
See Also:
java.lang.Double#toString(double)

print

public void print(char[] s)
Enabled: Print an array of characters. The characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
s - The array of chars to be printed
Throws:
NullPointerException - If s is null

print

public void print(String s)
Enabled: Print a string. If the argument is null then the string "null" is printed. Otherwise, the string's characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
s - The String to be printed

print

public void print(Object obj)
Enabled: Print an object. The string produced by the java.lang.String#valueOf(Object) method is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
obj - The Object to be printed
See Also:
java.lang.Object#toString()

println

public void println()
Enabled: Terminate the current line by writing the line separator string. The line separator string is defined by the system property line.separator, and is not necessarily a single newline character ('\n').


println

public void println(boolean x)
Enabled: Print a boolean and then terminate the line. This method behaves as though it invokes print(boolean) and then println().

Parameters:
x - The boolean to be printed

println

public void println(char x)
Enabled: Print a character and then terminate the line. This method behaves as though it invokes print(char) and then println().

Parameters:
x - The char to be printed.

println

public void println(int x)
Enabled: Print an integer and then terminate the line. This method behaves as though it invokes print(int) and then println().

Parameters:
x - The int to be printed.

println

public void println(long x)
Enabled: Print a long and then terminate the line. This method behaves as though it invokes print(long) and then println().

Parameters:
x - a The long to be printed.

println

public void println(float x)
Enabled: Print a float and then terminate the line. This method behaves as though it invokes print(float) and then println().

Parameters:
x - The float to be printed.

println

public void println(double x)
Enabled: Print a double and then terminate the line. This method behaves as though it invokes print(double) and then println().

Parameters:
x - The double to be printed.

println

public void println(char[] x)
Enabled: Print an array of characters and then terminate the line. This method behaves as though it invokes print(char[]) and then println().

Parameters:
x - an array of chars to print.

println

public void println(String x)
Enabled: Print a String and then terminate the line. This method behaves as though it invokes print(String) and then println().

Parameters:
x - The String to be printed.

println

public void println(Object x)
Enabled: Print an Object and then terminate the line. This method behaves as though it invokes print(Object) and then println().

Parameters:
x - The Object to be printed.


comments?