Module com.aoapps.lang

Package com.aoapps.lang.io

Interface Encoder

public interface Encoder

Encodes data as it is written to the provided output.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
Encoder	append(char c, Appendable out)
Encoder	append(CharSequence csq, int start, int end, Appendable out)
Encoder	append(CharSequence csq, Appendable out)
default boolean	isBuffered()	Is this encoder buffered? A buffered encoder may delay validation until writeSuffixTo(java.lang.Appendable, boolean).
void	write(char[] cbuf, int off, int len, Writer out)
void	write(char[] cbuf, Writer out)
void	write(int c, Writer out)
void	write(String str, int off, int len, Writer out)
void	write(String str, Writer out)
void	writePrefixTo(Appendable out)	This is called before any data is written.
void	writeSuffixTo(Appendable out)	Deprecated. Please use writeSuffixTo(java.lang.Appendable, boolean) while specifying desired trim.
default void	writeSuffixTo(Appendable out, boolean trim)	This is called when no more data will be written.

Method Detail

isBuffered

default boolean isBuffered()

Is this encoder buffered? A buffered encoder may delay validation until writeSuffixTo(java.lang.Appendable, boolean). Furthermore, a buffered encoder should not be bypassed before any buffered data has been written via writeSuffixTo(java.lang.Appendable, boolean). An example of encoder bypassing is performing direct output on the writer from EncoderWriter.getOut().

Returns:

false by default

writePrefixTo

void writePrefixTo(Appendable out)
            throws IOException

This is called before any data is written.

Parameters:

out - May optionally have already been optimized via Coercion.optimize(java.lang.Appendable, com.aoapps.lang.io.Encoder).

Throws:

IOException

write

void write(int c,
           Writer out)
    throws IOException

Throws:

IOException

write

void write(char[] cbuf,
           Writer out)
    throws IOException

Throws:

IOException

write

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

Throws:

IOException

write

void write(String str,
           Writer out)
    throws IOException

Throws:

IOException

write

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

Throws:

IOException

append

Encoder append(char c,
               Appendable out)
        throws IOException

Throws:

IOException

append

Encoder append(CharSequence csq,
               Appendable out)
        throws IOException

Throws:

IOException

append

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

Throws:

IOException

writeSuffixTo

@Deprecated
void writeSuffixTo(Appendable out)
            throws IOException

Deprecated.

Please use writeSuffixTo(java.lang.Appendable, boolean) while specifying desired trim.

This is called when no more data will be written. This should also flush any internal buffers to out. It should not, however, call flush on out itself. This is to not interfere with any output buffering of out.

The internal buffer is always clear for re-use, even when an exception is thrown.

Parameters:

out - May optionally have already been optimized via Coercion.optimize(java.lang.Appendable, com.aoapps.lang.io.Encoder).

Throws:

IOException

writeSuffixTo

default void writeSuffixTo(Appendable out,
                           boolean trim)
                    throws IOException

This is called when no more data will be written. This should also flush any internal buffers to out. It should not, however, call flush on out itself. This is to not interfere with any output buffering of out.

The internal buffer is always clear for re-use, even when an exception is thrown.

Parameters:

out - May optionally have already been optimized via Coercion.optimize(java.lang.Appendable, com.aoapps.lang.io.Encoder).

trim - Requests that the buffer be trimmed, if buffered and trim supported.

Throws:

IOException