java.io
Class PrintStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.PrintStream

public class PrintStream
extends OutputStream

A PrintStream adds functionality to another output stream, namely the ability to print representations of various data values conveniently. Two other features are provided as well. Unlike other output streams, a PrintStream never throws an IOException; instead, exceptional situations merely set an internal flag that can be tested via the checkError method. Optionally, a PrintStream can be created so as to flush automatically; this means that the flush method is automatically invoked after a byte array is written, one of the println methods is invoked, or a newline character or byte ('\n') is written.

All characters printed by a PrintStream are converted into bytes using the platform's default character encoding.

Since:
JDK1.0

Constructor Summary
PrintStream(OutputStream out)
          Create a new print stream.
 
Method Summary
 boolean checkError()
          Flush the stream and check its error state.
 void close()
          Close the stream.
 void flush()
          Flush the stream.
 void print(boolean b)
          Print a boolean value.
 void print(char c)
          Print a character.
 void print(char[] s)
          Print an array of characters.
 void print(double d)
          Print a double-precision floating point number.
 void print(float f)
          Print a floating point number.
 void print(int i)
          Print an integer.
 void print(Object obj)
          Print an object.
 void print(String s)
          Print a string.
 void print(long l)
          Print a long integer.
 void println()
          Terminate the current line by writing the line separator string.
 void println(boolean x)
          Print a boolean and then terminate the line.
 void println(char x)
          Print a character and then terminate the line.
 void println(char[] x)
          Print an array of characters and then terminate the line.
 void println(double x)
          Print a double and then terminate the line.
 void println(float x)
          Print a float and then terminate the line.
 void println(int x)
          Print an integer and then terminate the line.
 void println(Object x)
          Print an Object and then terminate the line.
 void println(String x)
          Print a String and then terminate the line.
 void println(long x)
          Print a long 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)
          Write len bytes from the specified byte array starting at offset off to this stream.
 void write(int b)
          Write the specified byte to this stream.
 
Methods inherited from class java.io.OutputStream
write
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

PrintStream

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

Parameters:
out - The output stream to which values and objects will be printed


Method Detail

flush

public void flush()
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 OutputStream
See Also:
OutputStream.flush()

close

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

Overrides:
close in class OutputStream
See Also:
OutputStream.close()

checkError

public boolean checkError()
Flush the stream and check its error state. The internal error state is set to true when the underlying output stream throws an IOException, and when the setError method is invoked.

Returns:
True if and only if this stream has encountered an IOException, 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)
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.

Specified by:
write in class OutputStream
Parameters:
b - The byte to be written
See Also:
PrintStream.print(char), PrintStream.println(char)

write

public void write(byte[] buf,
                  int off,
                  int len)
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 OutputStream
Parameters:
buf - A byte array
off - Offset from which to start taking bytes
len - Number of bytes to write

print

public void print(boolean b)
Print a boolean value. The string produced by 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 PrintStream.write(int) method.

Parameters:
b - The boolean to be printed

print

public void print(char c)
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 PrintStream.write(int) method.

Parameters:
c - The char to be printed

print

public void print(int i)
Print an integer. The string produced by 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 PrintStream.write(int) method.

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

print

public void print(long l)
Print a long integer. The string produced by 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 PrintStream.write(int) method.

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

print

public void print(float f)
Print a floating point number. The string produced by 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 PrintStream.write(int) method.

Parameters:
f - The float to be printed
See Also:
Float.toString(float)
Since:
BlackBerry API 4.0.0, CLDC 1.1

print

public void print(double d)
Print a double-precision floating point number. The string produced by 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 PrintStream.write(int) method.

Parameters:
d - The double to be printed
See Also:
Double.toString(double)
Since:
BlackBerry API 4.0.0, CLDC 1.1

print

public void print(char[] s)
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 PrintStream.write(int) method.

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

print

public void print(String s)
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 PrintStream.write(int) method.

Parameters:
s - The String to be printed

print

public void print(Object obj)
Print an object. The string produced by the 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 PrintStream.write(int) method.

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

println

public void println()
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)
Print a boolean and then terminate the line. This method behaves as though it invokes PrintStream.print(boolean) and then PrintStream.println().

Parameters:
x - The boolean to be printed

println

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

Parameters:
x - The char to be printed.

println

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

Parameters:
x - The int to be printed.

println

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

Parameters:
x - a The long to be printed.

println

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

Parameters:
x - The float to be printed.
Since:
BlackBerry API 4.0.0, CLDC 1.1

println

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

Parameters:
x - The double to be printed.
Since:
BlackBerry API 4.0.0, CLDC 1.1

println

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

Parameters:
x - an array of chars to print.

println

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

Parameters:
x - The String to be printed.

println

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

Parameters:
x - The Object to be printed.





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.