Class: java.io.PrintStream

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. The java.io.PrintWriter class should be used in situations that require writing characters rather than bytes.

Authors:
@author Frank Yellin
@author Mark Reinhold
Since:
@since JDK1.0

Inheritance

Superclass tree: Implements:

Methods

  • PrintStreamtop

    public PrintStream(File file) throws FileNotFoundException
    Creates a new print stream, without automatic line flushing, with the specified file. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the default charset for this instance of the Java virtual machine.
    Parameters:
    @param file The file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
    Exceptions:
    @throws FileNotFoundException If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
    @throws SecurityException If a security manager is present and checkWrite(file.getPath()) denies write access to the file
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • PrintStreamtop

    public PrintStream(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException
    Creates a new print stream, without automatic line flushing, with the specified file and charset. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the provided charset.
    Parameters:
    @param file The file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
    @param csn The name of a supported charset
    Exceptions:
    @throws FileNotFoundException If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
    @throws SecurityException If a security manager is presentand checkWrite(file.getPath()) denies write access to the file
    @throws UnsupportedEncodingException If the named charset is not supported
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • PrintStreamtop

    public PrintStream(OutputStream out)
    Creates a new print stream. This stream will not flush automatically.
    Parameters:
    @param out The output stream to which values and objects will be printed
    See:
    @see java.io.PrintWriter.PrintWriter(java.io.OutputStream)
    Related Links:
    Google Code Search
    Stack Overflow

  • PrintStreamtop

    public PrintStream(OutputStream out, boolean autoFlush)
    Creates a new print stream.
    Parameters:
    @param out The output stream to which values and objects will be printed
    @param 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:
    @see java.io.PrintWriter.PrintWriter(java.io.OutputStream, boolean)
    Related Links:
    Google Code Search
    Stack Overflow

  • PrintStreamtop

    public PrintStream(OutputStream out, boolean autoFlush, String encoding) throws UnsupportedEncodingException
    Creates a new print stream.
    Parameters:
    @param out The output stream to which values and objects will be printed
    @param 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
    @param encoding The name of a supported character encoding
    Exceptions:
    @throws UnsupportedEncodingException If the named encoding is not supported
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • PrintStreamtop

    public PrintStream(String fileName) throws FileNotFoundException
    Creates a new print stream, without automatic line flushing, with the specified file name. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the default charset for this instance of the Java virtual machine.
    Parameters:
    @param fileName The name of the file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
    Exceptions:
    @throws FileNotFoundException If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
    @throws SecurityException If a security manager is present and checkWrite(fileName) denies write access to the file
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • PrintStreamtop

    public PrintStream(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException
    Creates a new print stream, without automatic line flushing, with the specified file name and charset. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the provided charset.
    Parameters:
    @param fileName The name of the file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
    @param csn The name of a supported charset
    Exceptions:
    @throws FileNotFoundException If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
    @throws SecurityException If a security manager is present and checkWrite(fileName) denies write access to the file
    @throws UnsupportedEncodingException If the named charset is not supported
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public PrintStream append(char c)
    Appends the specified character to this output stream.

    An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation 

         out.print(c)
    Parameters:
    @param c The 16-bit character to append
    Return:
    @return This output stream
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public PrintStream append(CharSequence csq)
    Appends the specified character sequence to this output stream.

    An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation 

         out.print(csq.toString())

    Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking then toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

    Parameters:
    @param csq The character sequence to append. If csq is null, then the four characters "null" are appended to this output stream.
    Return:
    @return This output stream
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public PrintStream append(CharSequence csq, int start, int end)
    Appends a subsequence of the specified character sequence to this output stream.

    An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation 

         out.print(csq.subSequence(start, end).toString())
    Parameters:
    @param csq The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
    @param start The index of the first character in the subsequence
    @param end The index of the character following the last character in the subsequence
    Return:
    @return This output stream
    Exceptions:
    @throws IndexOutOfBoundsException If start or end are negative, start is greater than end, or end is greater than csq.length()
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Related Links:
    Google Code Search
    Stack Overflow

  • checkErrortop

    public boolean checkError()
    Flushes the stream and checks 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.
    Return:
    @return true if and only if this stream has encountered an IOException other than InterruptedIOException, or the setError method has been invoked
    Related Links:
    Google Code Search
    Stack Overflow

  • clearErrortop

    protected void clearError()
    Clears the internal error state of this stream.

    This method will cause subsequent invocations of java.io.PrintStream.checkError() to return false until another write operation fails and invokes java.io.PrintStream.setError().

    Since:
    @since 1.6
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close()
    Closes the stream. This is done by flushing the stream and then closing the underlying output stream.
    See:
    @see java.io.OutputStream.close()
    Specified by:
    close from Closeable
    Override hierarchy:
    close from FilterOutputStream
    close from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • flushtop

    public void flush()
    Flushes the stream. This is done by writing any buffered output bytes to the underlying output stream and then flushing that stream.
    See:
    @see java.io.OutputStream.flush()
    Specified by:
    flush from Flushable
    Override hierarchy:
    flush from FilterOutputStream
    flush from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • formattop

    public PrintStream format(String format, Object... args)
    Writes a formatted string to this output stream using the specified format string and arguments.

    The locale always used is the one returned by Locale.getDefault(), regardless of any previous invocations of other formatting methods on this object.

    Parameters:
    @param format A format string as described in Format string syntax
    @param args 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 the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
    Return:
    @return This output stream
    Exceptions:
    @throws IllegalFormatException 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 Details section of the formatter class specification.
    @throws NullPointerException If the format is null
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • formattop

    public PrintStream format(Locale l, String format, Object... args)
    Writes a formatted string to this output stream using the specified format string and arguments.
    Parameters:
    @param l The locale to apply during formatting. If l is null then no localization is applied.
    @param format A format string as described in Format string syntax
    @param args 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 the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
    Return:
    @return This output stream
    Exceptions:
    @throws IllegalFormatException 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 Details section of the formatter class specification.
    @throws NullPointerException If the format is null
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(char c)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param c The char to be printed
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(double d)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param d The double to be printed
    See:
    @see Double.toString(double)
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(float f)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param f The float to be printed
    See:
    @see Float.toString(float)
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(int i)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param i The int to be printed
    See:
    @see Integer.toString(int)
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(long l)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param l The long to be printed
    See:
    @see Long.toString(long)
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(Object obj)
    Prints an object. The string produced by the String.valueOf(java.lang.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 java.io.PrintStream.write(int) method.
    Parameters:
    @param obj The Object to be printed
    See:
    @see Object.toString()
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(String s)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param s The String to be printed
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(boolean b)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param b The boolean to be printed
    Related Links:
    Google Code Search
    Stack Overflow

  • printtop

    public void print(char[] s)
    Prints 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 java.io.PrintStream.write(int) method.
    Parameters:
    @param s The array of chars to be printed
    Exceptions:
    @throws NullPointerException If s is null
    Related Links:
    Google Code Search
    Stack Overflow

  • printftop

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

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

         out.format(format, args)
    Parameters:
    @param format A format string as described in Format string syntax
    @param args 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 the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
    Return:
    @return This output stream
    Exceptions:
    @throws IllegalFormatException 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 Details section of the formatter class specification.
    @throws NullPointerException If the format is null
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • printftop

    public PrintStream printf(Locale l, String format, Object... args)
    A convenience method to write a formatted string to this output stream using the specified format string and arguments.

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

         out.format(l, format, args)
    Parameters:
    @param l The locale to apply during formatting. If l is null then no localization is applied.
    @param format A format string as described in Format string syntax
    @param args 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 the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
    Return:
    @return This output stream
    Exceptions:
    @throws IllegalFormatException 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 Details section of the formatter class specification.
    @throws NullPointerException If the format is null
    Since:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println()
    Terminates 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').
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(char x)
    Prints a character and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(char) and then java.io.PrintStream.println().
    Parameters:
    @param x The char to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(double x)
    Prints a double and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(double) and then java.io.PrintStream.println().
    Parameters:
    @param x The double to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(float x)
    Prints a float and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(float) and then java.io.PrintStream.println().
    Parameters:
    @param x The float to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(int x)
    Prints an integer and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(int) and then java.io.PrintStream.println().
    Parameters:
    @param x The int to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(long x)
    Prints a long and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(long) and then java.io.PrintStream.println().
    Parameters:
    @param x a The long to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(Object x)
    Prints an Object and then terminate the line. This method calls at first String.valueOf(x) to get the printed object's string value, then behaves as though it invokes java.io.PrintStream.print(java.lang.String) and then java.io.PrintStream.println().
    Parameters:
    @param x The Object to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(String x)
    Prints a String and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(java.lang.String) and then java.io.PrintStream.println().
    Parameters:
    @param x The String to be printed.
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(boolean x)
    Prints a boolean and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(boolean) and then java.io.PrintStream.println().
    Parameters:
    @param x The boolean to be printed
    Related Links:
    Google Code Search
    Stack Overflow

  • printlntop

    public void println(char[] x)
    Prints an array of characters and then terminate the line. This method behaves as though it invokes java.io.PrintStream.print(char[]) and then java.io.PrintStream.println().
    Parameters:
    @param x an array of chars to print.
    Related Links:
    Google Code Search
    Stack Overflow

  • setErrortop

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

    This method will cause subsequent invocations of java.io.PrintStream.checkError() to return true until java.io.PrintStream.clearError() is invoked.

    Since:
    @since JDK1.1
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(int b)
    Writes 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.

    Parameters:
    @param b The byte to be written
    See:
    @see java.io.PrintStream.print(char)
    @see java.io.PrintStream.println(char)
    Override hierarchy:
    write from FilterOutputStream
    write from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(byte[] buf, int off, int len)
    Writes 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.

    Parameters:
    @param buf A byte array
    @param off Offset from which to start taking bytes
    @param len Number of bytes to write
    Override hierarchy:
    write from FilterOutputStream
    write from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow