com.github.robtimus.io.stream

Class LimitWriter

java.lang.Object

java.io.Writer

com.github.robtimus.io.stream.LimitWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public final class LimitWriter
extends Writer

A writer that limits the number of characters that can be written to another writer.

If a write call causes the limit to be exceeded and the limit writer is configured to throw an exception, the call will lead to a LimitExceededException to be thrown.

Author:

Rob Spoor

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
LimitWriter(Writer writer, long limit) Creates a new limit writer.
LimitWriter(Writer writer, long limit, LimitExceededStrategy strategy) Creates a new limit writer.

Method Summary

Modifier and Type	Method and Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
void	close()
void	flush()
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str, int off, int len)

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

Constructor Detail

LimitWriter

public LimitWriter(Writer writer,
                   long limit)

Creates a new limit writer. This writer will discard any excess characters.

Parameters:

writer - The writer for which to limit the number of characters that can be written.

limit - The maximum number of characters that can be written.

Throws:

NullPointerException - If the given writer is null.

IllegalArgumentException - If the given limit is negative.

LimitWriter

public LimitWriter(Writer writer,
                   long limit,
                   LimitExceededStrategy strategy)

Creates a new limit writer.

Parameters:

writer - The writer for which to limit the number of characters that can be written.

limit - The maximum number of characters that can be written.

strategy - The strategy to follow when the maximum number of characters has exceeded.

Throws:

NullPointerException - If the given writer or strategy is null.

IllegalArgumentException - If the given limit is negative.

Method Detail

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq,
                     int start,
                     int end)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(char c)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException