com.goldencode.p2j.io

Class IndentingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.goldencode.p2j.io.IndentingOutputStream

All Implemented Interfaces:

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

public class IndentingOutputStream
extends java.io.FilterOutputStream
implements Indentable

Provides OutputStream semantics with caller-controlled indenting. An indent is written (inserted) between each newline and any subsequent (non-newline) bytes that are written.

This class is not thread-safe.

Author:

GES

Field Summary

Fields

Modifier and Type	Field and Description
private Indentable	indent Indent state manager.
private byte	last The last byte written to the stream.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
IndentingOutputStream(java.io.OutputStream out) Creates an instance with the associated output stream as the base and a default 0 indent level.
IndentingOutputStream(java.io.OutputStream out, int indent) Creates an instance with the associated output stream as the base.

Method Summary

Modifier and Type	Method and Description
void	decrement() Decrements the indent level by 1.
int	getIndent() Accesses the current indent level.
java.lang.String	getPad() Get the current pad.
int	getWidth() Accesses the number of spaces in a single indent level.
void	increment() Increments the indent level by 1.
void	setIndent(int indent) Sets the current indent level.
void	setPad(int indent, int width) Sets both the indent level and the number of spaces in a single indent level.
void	setWidth(int width) Sets the number of spaces in a single indent level.
void	write(byte[] b) Writes the entire contents of the specified byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off in this output stream.
void	write(int b) Writes the specified byte to this output stream (only the low order 8 bits are written, the high order 24 bits are ignored).

Methods inherited from class java.io.FilterOutputStream

close, flush

Methods inherited from class java.lang.Object

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

Field Detail

indent

private Indentable indent

Indent state manager.

last

private byte last

The last byte written to the stream.

Constructor Detail

IndentingOutputStream

public IndentingOutputStream(java.io.OutputStream out)

Creates an instance with the associated output stream as the base and a default 0 indent level.

Parameters:

out - The stream on which we filter.

IndentingOutputStream

public IndentingOutputStream(java.io.OutputStream out,
                             int indent)

Creates an instance with the associated output stream as the base.

Parameters:

out - The stream on which we filter.

indent - The initial indent level.

Method Detail

getIndent

public int getIndent()

Accesses the current indent level.

Specified by:

getIndent in interface Indentable

Returns:

Indent level.

setIndent

public void setIndent(int indent)

Sets the current indent level.

Specified by:

setIndent in interface Indentable

Parameters:

indent - New indent level.

increment

public void increment()

Increments the indent level by 1.

Specified by:

increment in interface Indentable

decrement

public void decrement()

Decrements the indent level by 1.

Specified by:

decrement in interface Indentable

getWidth

public int getWidth()

Accesses the number of spaces in a single indent level.

Specified by:

getWidth in interface Indentable

Returns:

Width of each indent level.

setWidth

public void setWidth(int width)

Sets the number of spaces in a single indent level.

Specified by:

setWidth in interface Indentable

Parameters:

width - New indent width.

getPad

public java.lang.String getPad()

Get the current pad.

Specified by:

getPad in interface Indentable

Returns:

The pad string for the next line of output.

setPad

public void setPad(int indent,
                   int width)

Sets both the indent level and the number of spaces in a single indent level. This is a convenience function to avoid 2 separate calls and the small amount of shared overhead that would have been incurred in those calls.

Specified by:

setPad in interface Indentable

Parameters:

indent - New indent level.

width - New indent width.

write

public void write(int b)
           throws java.io.IOException

Writes the specified byte to this output stream (only the low order 8 bits are written, the high order 24 bits are ignored).

The current pad is inserted into the stream between all newline characters and any subsequent non-newline bytes.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - The byte to write.

Throws:

java.io.IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

public void write(byte[] b)
           throws java.io.IOException,
                  java.lang.NullPointerException

Writes the entire contents of the specified byte array to this output stream.

The current pad is inserted into the stream between all newline characters and any subsequent non-newline bytes.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - The byte array to write.

Throws:

java.io.IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

java.lang.NullPointerException - If the array is null.

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException,
                  java.lang.NullPointerException,
                  java.lang.IndexOutOfBoundsException

Writes len bytes from the specified byte array starting at offset off in this output stream. Element b[off] is the first byte written and b[off+len-1] is the last byte written.

The current pad is inserted into the stream between all newline characters and any subsequent non-newline bytes.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - The array of bytes to write.

off - The start offset in the array.

len - The number of bytes to write.

Throws:

java.io.IOException - If an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

java.lang.NullPointerException - If the array is null.

java.lang.IndexOutOfBoundsException - If the offset or length are negative, or if offset + length is larger than the length of the array.