org.ka2ddo.yaac.io

Class NonshareableBufferedPrintStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.ka2ddo.yaac.io.NonshareableBufferedPrintStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class NonshareableBufferedPrintStream
extends java.io.FilterOutputStream
implements java.lang.Appendable

This class implements a non-mutexing buffered version of PrintStream, locked to the UTF-8 encoding, with no autoflushing. Unfortunately, to eliminate spurious memory allocations, this class no longer subclasses java.io.PrintStream.

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
NonshareableBufferedPrintStream(java.io.OutputStream out) Creates a new buffered output stream to write data to the specified underlying output stream.
NonshareableBufferedPrintStream(java.io.OutputStream out, byte[] buf) Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer.
NonshareableBufferedPrintStream(java.io.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 Type	Method and Description
NonshareableBufferedPrintStream	append(char c) Appends the specified character to this output stream.
NonshareableBufferedPrintStream	append(java.lang.CharSequence csq) Appends the specified character sequence to this output stream.
NonshareableBufferedPrintStream	append(java.lang.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.
NonshareableBufferedPrintStream	format(java.util.Locale l, java.lang.String format, java.lang.Object... args) Writes a formatted string to this output stream using the specified format string and arguments.
NonshareableBufferedPrintStream	format(java.lang.String format, java.lang.Object... args) 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	print(java.lang.Object obj) Prints an object.
void	print(java.lang.String s) Prints a string.
NonshareableBufferedPrintStream	printf(java.util.Locale l, java.lang.String format, java.lang.Object... args) A convenience method to write a formatted string to this output stream using the specified format string and arguments.
NonshareableBufferedPrintStream	printf(java.lang.String format, java.lang.Object... args) 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	println(java.lang.Object x) Prints an Object and then terminate the line.
void	println(java.lang.String x) Prints a String and then terminate the line.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off 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.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NonshareableBufferedPrintStream

public NonshareableBufferedPrintStream(java.io.OutputStream out)

Creates a new buffered output stream to write data to the specified underlying output stream.

Parameters:

out - the underlying output stream.

NonshareableBufferedPrintStream

public NonshareableBufferedPrintStream(java.io.OutputStream out,
                                       int size)

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:

java.lang.IllegalArgumentException - if size < 8.

NonshareableBufferedPrintStream

public NonshareableBufferedPrintStream(java.io.OutputStream out,
                                       byte[] buf)

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:

java.lang.IllegalArgumentException - if buf.length < 8.

Method Detail

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) or println(char) methods.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - The byte to be written

See Also:

print(char), println(char)

write

public void write(byte[] b,
                  int off,
                  int len)

Writes len bytes from the specified byte array starting at offset off 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) or println(char) methods.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - A byte array

off - Offset from which to start taking bytes

len - Number of bytes to write

print

public void print(boolean b)

Prints a boolean value. The string produced by String.valueOf(boolean) is translated into bytes according to the UTF-8 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)

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 write(int) method.

Parameters:

c - The char to be printed

print

public void print(int i)

Prints an integer. The string produced by String.valueOf(int) is translated into bytes according to the UTF-8 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:

Integer.toString(int)

print

public void print(long l)

Prints a long integer. The string produced by String.valueOf(long) is translated into bytes according to the UTF-8 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:

Long.toString(long)

print

public void print(float f)

Prints a floating-point number. The string produced by String.valueOf(float) is translated into bytes according to the UTF-8 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:

Float.toString(float)

print

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 UTF-8 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:

Double.toString(double)

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 write(int) method.

Parameters:

s - The array of chars to be printed

Throws:

java.lang.NullPointerException - If s is null

print

public void print(java.lang.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 UTF-8 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(java.lang.Object obj)

Prints an object. The string produced by the String.valueOf(Object) method is translated into bytes according to the UTF-8 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:

Object.toString()

println

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').

println

public void println(boolean x)

Prints 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)

Prints 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)

Prints 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)

Prints 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)

Prints 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)

Prints 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)

Prints 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(java.lang.String x)

Prints 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(java.lang.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 print(String) and then println().

Parameters:

x - The Object 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 interface java.io.Flushable

Overrides:

flush in class java.io.FilterOutputStream

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 interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterOutputStream

See Also:

OutputStream.close()

printf

public NonshareableBufferedPrintStream printf(java.lang.String format,
                                              java.lang.Object... args)
                                       throws java.util.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 invocation

     out.format(format, args) 

Parameters:

format - A format string as described in Format string syntax

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 java.util.Formatter syntax conversion.

Returns:

This output stream

Throws:

java.util.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.

java.lang.NullPointerException - If the format is null

Since:

1.5

printf

public NonshareableBufferedPrintStream printf(java.util.Locale l,
                                              java.lang.String format,
                                              java.lang.Object... args)
                                       throws java.util.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 invocation

     out.format(l, format, args) 

Parameters:

l - The locale to apply during formatting. If l is null then no localization is applied.

format - A format string as described in Format string syntax

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 java.util.Formatter syntax conversion.

Returns:

This output stream

Throws:

java.util.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.

java.lang.NullPointerException - If the format is null

Since:

1.5

format

public NonshareableBufferedPrintStream format(java.lang.String format,
                                              java.lang.Object... args)
                                       throws java.util.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 syntax

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 java.util.Formatter syntax conversion.

Returns:

This output stream

Throws:

java.util.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.

java.lang.NullPointerException - If the format is null

Since:

1.5

format

public NonshareableBufferedPrintStream format(java.util.Locale l,
                                              java.lang.String format,
                                              java.lang.Object... args)
                                       throws java.util.IllegalFormatException

Writes a formatted string to this output stream using the specified format string and arguments.

Parameters:

l - The locale to apply during formatting. If l is null then no localization is applied.

format - A format string as described in Format string syntax

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 java.util.Formatter syntax conversion.

Returns:

This output stream

Throws:

java.util.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.

java.lang.NullPointerException - If the format is null

Since:

1.5

append

public NonshareableBufferedPrintStream append(java.lang.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.

Specified by:

append in interface java.lang.Appendable

Parameters:

csq - The character sequence to append. If csq is null, then the four characters "null" are appended to this output stream.

Returns:

This output stream

Since:

1.5

append

public NonshareableBufferedPrintStream append(java.lang.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()) 

Specified by:

append in interface java.lang.Appendable

Parameters:

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".

start - The index of the first character in the subsequence

end - The index of the character following the last character in the subsequence

Returns:

This output stream

Throws:

java.lang.IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()

append

public NonshareableBufferedPrintStream 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) 

Specified by:

append in interface java.lang.Appendable

Parameters:

c - The 16-bit character to append

Returns:

This output stream

Since:

1.5