de.uni_hildesheim.sse.monitoring.runtime.wrap

Class DelegatingWriter

java.lang.Object

java.io.Writer

de.uni_hildesheim.sse.monitoring.runtime.wrap.DelegatingWriter

All Implemented Interfaces:

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

public class DelegatingWriter
extends java.io.Writer

A writer delegating its operation to an arbitrary writer while notifying the recorder about performed operations.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inWrite1 Stores if we are in a write method with 1 parameter (avoid double recording).
private boolean	inWrite3 Stores if we are in a write method with 3 parameters (avoid double recording).
private java.lang.String	recId Stores the recorder id to aggregate the notifications for.
private StreamType	type Stores the type of stream to delegate to.
private java.io.Writer	writer Stores the writer to delegate to.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
DelegatingWriter(java.io.Writer writer, StreamType type) Creates a delegating writer.
DelegatingWriter(java.io.Writer writer, StreamType type, java.lang.String recId) Creates a delegating writer.

Method Summary

Modifier and Type	Method and Description
java.io.Writer	append(char ch) Appends the specified character to this writer.
java.io.Writer	append(java.lang.CharSequence csq) Appends the specified character sequence to this writer.
java.io.Writer	append(java.lang.CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
void	close() Closes the stream.
void	flush() Flushes the contents.
void	write(char[] buffer) Writes a data array.
void	write(char[] buffer, int off, int len) Writes a portion of a data array.
void	write(int value) Writes a char to the writer.

Methods inherited from class java.io.Writer

write, write

Methods inherited from class java.lang.Object

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

Field Detail

writer

private java.io.Writer writer

Stores the writer to delegate to.

inWrite3

private boolean inWrite3

Stores if we are in a write method with 3 parameters (avoid double recording).

inWrite1

private boolean inWrite1

Stores if we are in a write method with 1 parameter (avoid double recording).

type

private StreamType type

Stores the type of stream to delegate to.

recId

private java.lang.String recId

Stores the recorder id to aggregate the notifications for.

Constructor Detail

DelegatingWriter

public DelegatingWriter(java.io.Writer writer,
                        StreamType type)

Creates a delegating writer.

Parameters:

writer - the writer to delegate to.

type - the type of stream

Since:

1.00

DelegatingWriter

public DelegatingWriter(java.io.Writer writer,
                        StreamType type,
                        java.lang.String recId)

Creates a delegating writer.

Parameters:

writer - the writer to delegate to.

type - the type of stream

recId - the recorder id to aggregate the notifications for

Since:

1.00

Method Detail

write

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

Writes a char to the writer.

Overrides:

write in class java.io.Writer

Parameters:

value - the char

Throws:

java.io.IOException - If an I/O error occurs

write

public void write(char[] buffer)
           throws java.io.IOException

Writes a data array.

Overrides:

write in class java.io.Writer

Parameters:

buffer - the data array

Throws:

java.io.IOException - If an I/O error occurs

write

public void write(char[] buffer,
                  int off,
                  int len)
           throws java.io.IOException

Writes a portion of a data array.

Specified by:

write in class java.io.Writer

Parameters:

buffer - the data array

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

java.io.IOException - If an I/O error occurs

flush

public void flush()
           throws java.io.IOException

Flushes the contents.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException - in case of I/O errors

close

public void close()
           throws java.io.IOException

Closes the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException - in case of I/O errors

append

public java.io.Writer append(char ch)
                      throws java.io.IOException

Appends the specified character to this writer.

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Parameters:

ch - The 16-bit character to append

Returns:

This writer

Throws:

java.io.IOException - If an I/O error occurs

append

public java.io.Writer append(java.lang.CharSequence csq)
                      throws java.io.IOException

Appends the specified character sequence to this writer.

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Parameters:

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

Returns:

This writer

Throws:

java.io.IOException - If an I/O error occurs

append

public java.io.Writer append(java.lang.CharSequence csq,
                             int start,
                             int end)
                      throws java.io.IOException

Appends a subsequence of the specified character sequence to this writer. Appendable.

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

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 writer

Throws:

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

java.io.IOException - If an I/O error occurs