io.warp10.json

Class BoundedWriter

java.lang.Object

java.io.Writer

io.warp10.json.BoundedWriter

All Implemented Interfaces:

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

public class BoundedWriter
extends java.io.Writer

A wrapper for Writers to limit the number of written chars. When the number of chars that should be written exceeds the given limit, a WriterBoundReachedException is thrown.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoundedWriter.WriterBoundReachedException

Field Summary

Fields

Modifier and Type	Field and Description
protected long	currentWrittenChars
protected long	maxWrittenChars
protected java.io.Writer	writer

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
BoundedWriter(java.io.Writer writer, long maxAppendedChars)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.

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, toString, wait, wait, wait

Field Detail

writer

protected final java.io.Writer writer

maxWrittenChars

protected final long maxWrittenChars

currentWrittenChars

protected long currentWrittenChars

Constructor Detail

BoundedWriter

public BoundedWriter(java.io.Writer writer,
                     long maxAppendedChars)

Method Detail

write

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

Writes a portion of an array of characters.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

BoundedWriter.WriterBoundReachedException - if this write would exceed the maximum number of written characters to this writer.

java.io.IOException - if this the underlying writer throws an IOException.

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

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