Class NonshareableBufferedPrintStream
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
- Author:
- Andrew Pavlin, KA2DDO
-
Field Summary
Fields inherited from class java.io.FilterOutputStream
out
-
Constructor Summary
ConstructorDescriptionCreates a new buffered output stream to write data to the specified underlying output stream.NonshareableBufferedPrintStream
(OutputStream out, byte[] buf) Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer.NonshareableBufferedPrintStream
(OutputStream out, int size) Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size. -
Method Summary
Modifier and TypeMethodDescriptionappend
(char c) Appends the specified character to this output stream.append
(CharSequence csq) Appends the specified character sequence to this output stream.append
(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this output stream.void
close()
Closes the stream.void
flush()
Flushes this buffered output stream.Writes a formatted string to this output stream using the specified format string and arguments.Writes a formatted string to this output stream using the specified format string and arguments.void
print
(boolean b) Prints a boolean value.void
print
(char c) Prints a character.void
print
(char[] s) Prints an array of characters.void
print
(double d) Prints a double-precision floating-point number.void
print
(float f) Prints a floating-point number.void
print
(int i) Prints an integer.void
print
(long l) Prints a long integer.void
Prints an object.void
Prints a string.A convenience method to write a formatted string to this output stream using the specified format string and arguments.A convenience method to write a formatted string to this output stream using the specified format string and arguments.void
println()
Terminates the current line by writing the line separator string.void
println
(boolean x) Prints a boolean and then terminate the line.void
println
(char x) Prints a character and then terminate the line.void
println
(char[] x) Prints an array of characters and then terminate the line.void
println
(double x) Prints a double and then terminate the line.void
println
(float x) Prints a float and then terminate the line.void
println
(int x) Prints an integer and then terminate the line.void
println
(long x) Prints a long and then terminate the line.void
Prints an Object and then terminate the line.void
Prints a String and then terminate the line.void
write
(byte[] b, int off, int len) Writeslen
bytes from the specified byte array starting at offsetoff
to this stream.void
write
(int b) Writes the specified byte to this stream.Methods inherited from class java.io.FilterOutputStream
write
Methods inherited from class java.io.OutputStream
nullOutputStream
-
Constructor Details
-
NonshareableBufferedPrintStream
Creates a new buffered output stream to write data to the specified underlying output stream.- Parameters:
out
- the underlying output stream.
-
NonshareableBufferedPrintStream
Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.- Parameters:
out
- the underlying output stream.size
- the buffer size.- Throws:
IllegalArgumentException
- if size < 8.
-
NonshareableBufferedPrintStream
Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer.- Parameters:
out
- the underlying output stream.buf
- the buffer to use- Throws:
IllegalArgumentException
- if buf.length < 8.
-
-
Method Details
-
write
public void write(int b) Writes the specified byte to this stream.Note that the byte is written as given; to write a character that will be translated according to the UTF-8 character encoding, use the
print(char)
orprintln(char)
methods.- Overrides:
write
in classFilterOutputStream
- Parameters:
b
- The byte to be written- See Also:
-
write
public void write(byte[] b, int off, int len) Writeslen
bytes from the specified byte array starting at offsetoff
to this stream.Note that the bytes will be written as given; to write characters that will be translated according to the UTF-8 character encoding, use the
print(char)
orprintln(char)
methods.- Overrides:
write
in classFilterOutputStream
- Parameters:
b
- A byte arrayoff
- Offset from which to start taking byteslen
- Number of bytes to write
-
print
public void print(boolean b) Prints a boolean value. The string produced by
is translated into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of theString.valueOf(boolean)
method.write(int)
- Parameters:
b
- Theboolean
to be printed
-
print
public void print(char c) Prints a character. The character is translated into one or more bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of the
method.write(int)
- Parameters:
c
- Thechar
to be printed
-
print
public void print(int i) Prints an integer. The string produced by
is translated into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of theString.valueOf(int)
method.write(int)
- Parameters:
i
- Theint
to be printed- See Also:
-
print
public void print(long l) Prints a long integer. The string produced by
is translated into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of theString.valueOf(long)
method.write(int)
- Parameters:
l
- Thelong
to be printed- See Also:
-
print
public void print(float f) Prints a floating-point number. The string produced by
is translated into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of theString.valueOf(float)
method.write(int)
- Parameters:
f
- Thefloat
to be printed- See Also:
-
print
public void print(double d) Prints a double-precision floating-point number. The string produced by
is translated into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of theString.valueOf(double)
method.write(int)
- Parameters:
d
- Thedouble
to be printed- See Also:
-
print
public void print(char[] s) Prints an array of characters. The characters are converted into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of the
method.write(int)
- Parameters:
s
- The array of chars to be printed- Throws:
NullPointerException
- Ifs
isnull
-
print
Prints a string. If the argument isnull
then the string"null"
is printed. Otherwise, the string's characters are converted into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of the
method.write(int)
- Parameters:
s
- TheString
to be printed
-
print
Prints an object. The string produced by the
method is translated into bytes according to the UTF-8 character encoding, and these bytes are written in exactly the manner of theString.valueOf(Object)
method.write(int)
- Parameters:
obj
- TheObject
to be printed- See Also:
-
println
public void println()Terminates the current line by writing the line separator string. The line separator string is defined by the system propertyline.separator
, and is not necessarily a single newline character ('\n'
). -
println
public void println(boolean x) Prints a boolean and then terminate the line. This method behaves as though it invokes
and thenprint(boolean)
.println()
- Parameters:
x
- Theboolean
to be printed
-
println
public void println(char x) Prints a character and then terminate the line. This method behaves as though it invokes
and thenprint(char)
.println()
- Parameters:
x
- Thechar
to be printed.
-
println
public void println(int x) Prints an integer and then terminate the line. This method behaves as though it invokes
and thenprint(int)
.println()
- Parameters:
x
- Theint
to be printed.
-
println
public void println(long x) Prints a long and then terminate the line. This method behaves as though it invokes
and thenprint(long)
.println()
- Parameters:
x
- a Thelong
to be printed.
-
println
public void println(float x) Prints a float and then terminate the line. This method behaves as though it invokes
and thenprint(float)
.println()
- Parameters:
x
- Thefloat
to be printed.
-
println
public void println(double x) Prints a double and then terminate the line. This method behaves as though it invokes
and thenprint(double)
.println()
- Parameters:
x
- Thedouble
to be printed.
-
println
public void println(char[] x) Prints an array of characters and then terminate the line. This method behaves as though it invokes
and thenprint(char[])
.println()
- Parameters:
x
- an array of chars to print.
-
println
Prints a String and then terminate the line. This method behaves as though it invokes
and thenprint(String)
.println()
- Parameters:
x
- TheString
to be printed.
-
println
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
and thenprint(String)
.println()
- Parameters:
x
- TheObject
to be printed.
-
flush
public void flush()Flushes this buffered output stream. This forces any buffered output bytes to be written out to the underlying output stream.- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classFilterOutputStream
-
close
public void close()Closes the stream. This is done by flushing the stream and then closing the underlying output stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classFilterOutputStream
- See Also:
-
printf
public NonshareableBufferedPrintStream printf(String format, Object... args) throws IllegalFormatException 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 invocationout.format(format, args)
- Parameters:
format
- A format string as described in Format string syntaxargs
- 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 anull
argument depends on the java.util.Formatter syntax conversion.- Returns:
- This output stream
- 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.NullPointerException
- If theformat
isnull
- Since:
- 1.5
-
printf
public NonshareableBufferedPrintStream printf(Locale l, String format, Object... args) throws IllegalFormatException 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 invocationout.format(l, format, args)
- Parameters:
l
- The locale to apply during formatting. Ifl
isnull
then no localization is applied.format
- A format string as described in Format string syntaxargs
- 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 anull
argument depends on the java.util.Formatter syntax conversion.- Returns:
- This output stream
- 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.NullPointerException
- If theformat
isnull
- Since:
- 1.5
-
format
public NonshareableBufferedPrintStream format(String format, Object... args) throws IllegalFormatException 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:
format
- A format string as described in Format string syntaxargs
- 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 anull
argument depends on the java.util.Formatter syntax conversion.- Returns:
- This output stream
- 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.NullPointerException
- If theformat
isnull
- Since:
- 1.5
-
format
public NonshareableBufferedPrintStream format(Locale l, String format, Object... args) throws IllegalFormatException Writes a formatted string to this output stream using the specified format string and arguments.- Parameters:
l
- The locale to apply during formatting. Ifl
isnull
then no localization is applied.format
- A format string as described in Format string syntaxargs
- 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 anull
argument depends on the java.util.Formatter syntax conversion.- Returns:
- This output stream
- 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.NullPointerException
- If theformat
isnull
- Since:
- 1.5
-
append
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 invocationout.print(csq.toString())
Depending on the specification of
toString
for the character sequencecsq
, the entire sequence may not be appended. For instance, invoking thentoString
method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.- Specified by:
append
in interfaceAppendable
- Parameters:
csq
- The character sequence to append. Ifcsq
isnull
, then the four characters"null"
are appended to this output stream.- Returns:
- This output stream
- Since:
- 1.5
-
append
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)
whencsq
is notnull
, behaves in exactly the same way as the invocationout.print(csq.subSequence(start, end).toString())
- Specified by:
append
in interfaceAppendable
- Parameters:
csq
- The character sequence from which a subsequence will be appended. Ifcsq
isnull
, then characters will be appended as ifcsq
contained the four characters"null"
.start
- The index of the first character in the subsequenceend
- The index of the character following the last character in the subsequence- Returns:
- This output stream
- Throws:
IndexOutOfBoundsException
- Ifstart
orend
are negative,start
is greater thanend
, orend
is greater thancsq.length()
-
append
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 invocationout.print(c)
- Specified by:
append
in interfaceAppendable
- Parameters:
c
- The 16-bit character to append- Returns:
- This output stream
- Since:
- 1.5
-