com.mitchellbosecke.pebble.utils

Class LimitedSizeWriter

java.lang.Object

java.io.Writer

com.mitchellbosecke.pebble.utils.LimitedSizeWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class LimitedSizeWriter
extends Writer

A Writer that will wrap around the internal writer if the user also provided a limit on the size of the rendered template. The context is shared between all the writers used to evaluate a template: the one supplied by the user when calling template.evaluate as well as any internally created writers e.g. when evaluating a macro. There will be false positives. For example if a function writes something and its output is passed to a filter than we count both the output of the function and the output of the filter, when we should only count the output of the filter. This is fine because the user can increase the maximum allowable size accordingly. The purpose here is not to be precise but to protect against abuse. If the limit is reached a PebbleException will be thrown. If the limit is negative then no checks will be performed and the original writer used as is. This is thread-safe if RenderedSizeContext is thread-safe.

Field Summary

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
static Writer	from(Writer internalWriter, RenderedSizeContext context)
String	toString()
void	write(char[] cbuf, 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

Method Detail

from

public static Writer from(Writer internalWriter,
                          RenderedSizeContext context)

write

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

Specified by:

write 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

toString

public String toString()

Overrides:

toString in class Object