org.spf4j.io

Class AppendableLimiterWithOverflow

java.lang.Object

org.spf4j.io.AppendableLimiterWithOverflow

All Implemented Interfaces:

Closeable, Appendable, AutoCloseable

@Beta
 @CleanupObligation
public final class AppendableLimiterWithOverflow
extends Object
implements Appendable, Closeable

Utility class that limits the nr of characters written to a particular Appender. if nr of characters exceed the limit the character above the limit + entire message are written to the specified file. THe destination appender will contain the chars that fit the limit + a reference to the overflow file if overflow happened.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AppendableLimiterWithOverflow.OverflowSupplier provide the overflow.

Constructor Summary

Constructors

Constructor and Description
AppendableLimiterWithOverflow(int limit, Appendable destination, AppendableLimiterWithOverflow.OverflowSupplier owflSupplier)
AppendableLimiterWithOverflow(int limit, File overflowFile, CharSequence destinationSuffix, Charset characterSet, Appendable destination)

Method Summary

Modifier and Type	Method and Description
Appendable	append(char c)
Appendable	append(CharSequence csq)
Appendable	append(CharSequence csq, int start, int end)
void	close()
void	createOverflowIfNeeded()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AppendableLimiterWithOverflow

public AppendableLimiterWithOverflow(int limit,
                                     File overflowFile,
                                     CharSequence destinationSuffix,
                                     Charset characterSet,
                                     Appendable destination)

AppendableLimiterWithOverflow

public AppendableLimiterWithOverflow(int limit,
                                     Appendable destination,
                                     AppendableLimiterWithOverflow.OverflowSupplier owflSupplier)

Method Detail

append

public Appendable append(CharSequence csq)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Throws:

IOException

append

public Appendable append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

createOverflowIfNeeded

public void createOverflowIfNeeded()
                            throws IOException

Throws:

IOException

close

@DischargesObligation
public void close()
                                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object