Module io.jstach.jstachio

Package io.jstach.jstachio.output

Class ForwardingEncodedOutput<E extends Exception>

java.lang.Object

io.jstach.jstachio.output.ForwardingOutput<E>

io.jstach.jstachio.output.ForwardingEncodedOutput<E>

Type Parameters:

E - error throw on any append or write

All Implemented Interfaces:

Output<E>, Output.EncodedOutput<E>

public abstract class ForwardingEncodedOutput<E extends Exception>
extends ForwardingOutput<E>
implements Output.EncodedOutput<E>

An encoded output that forwards all calls to a delegate.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jstach.jstachio.Output

Output.CloseableEncodedOutput<E extends Exception>, Output.EncodedOutput<E extends Exception>, Output.StringOutput

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingEncodedOutput()	Do nothing constructor

Method Summary

Modifier and Type	Method	Description
Charset	charset()	The charset that the encoded output should be.
protected abstract Output.EncodedOutput<E>	delegate()	The output to forward to.
void	write(byte[] bytes)	Analogous to OutputStream.write(byte[]).
void	write(byte[] bytes, int off, int len)	Analogous to OutputStream.write(byte[], int, int).

Methods inherited from class io.jstach.jstachio.output.ForwardingOutput

append, append, append, append, append, append, append, append, append, toAppendable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jstach.jstachio.Output

append, append, append, append, append, append, toAppendable

Methods inherited from interface io.jstach.jstachio.Output.EncodedOutput

append, append, append

Constructor Details

ForwardingEncodedOutput

protected ForwardingEncodedOutput()

Do nothing constructor

Method Details

write

public void write(byte[] bytes)
           throws E

Description copied from interface: Output.EncodedOutput

Analogous to OutputStream.write(byte[]). Implementations should not alter the byte array.

Specified by:

write in interface Output.EncodedOutput<E extends Exception>

Parameters:

bytes - already encoded bytes

Throws:

E - if an error happens

write

public void write(byte[] bytes,
 int off,
 int len)
           throws E

Description copied from interface: Output.EncodedOutput

Analogous to OutputStream.write(byte[], int, int). Generated templates do not call this method as great care as to be taken to preserve the encoding. It is only provided in the case of future found optimizations and is not currently required.

The default implementation creates an array copies the data and then calls Output.EncodedOutput.write(byte[]).

Specified by:

write in interface Output.EncodedOutput<E extends Exception>

Parameters:

bytes - already encoded bytes

off - offset

len - length to copy

Throws:

E - if an error happens

charset

public Charset charset()

Description copied from interface: Output.EncodedOutput

The charset that the encoded output should be.

Specified by:

charset in interface Output.EncodedOutput<E extends Exception>

Returns:

expected charset

delegate

protected abstract Output.EncodedOutput<E> delegate()

Description copied from class: ForwardingOutput

The output to forward to.

Specified by:

delegate in class ForwardingOutput<E extends Exception>

Returns:

output to forward to.