org.ow2.proactive.utils

Class BoundedStringWriter

java.lang.Object

java.io.Writer

org.ow2.proactive.utils.BoundedStringWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class BoundedStringWriter
extends Writer

BoundedStringWriter that keeps a limited amount (maxLength) of chars into a sliding (elements are added and removed from the head) buffer and always prints them to an output sink. It ensures the size is never greater than the maximum size given in the constructor. Closing a BoundedStringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Since:

ProActive Scheduling 3.2

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
BoundedStringWriter(PrintStream outputSink, int maxSize) Create a new bounded string writer using the default maximum size.

Method Summary

Modifier and Type	Method and Description
void	close() Closing a BoundedStringWriter has no effect.
void	flush() Flush the stream.
StringBuilder	getBuilder() Return the string builder itself.
void	setContentBuffer(StringBuilder builder)
String	toString()
void	write(char[] c, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedStringWriter

public BoundedStringWriter(PrintStream outputSink,
                           int maxSize)

Create a new bounded string writer using the default maximum size.

Method Detail

write

public void write(char[] c,
                  int off,
                  int len)

Specified by:

write in class Writer

setContentBuffer

public void setContentBuffer(StringBuilder builder)

getBuilder

public StringBuilder getBuilder()

Return the string builder itself.

Returns:

StringBuilder holding the current buffer value.

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Closing a BoundedStringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Flush the stream.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException