Module com.aoapps.lang

Package com.aoapps.lang.io

Class EncoderWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.lang.io.EncoderWriter

All Implemented Interfaces:

NoClose, Closeable, Flushable, Appendable, AutoCloseable

public class EncoderWriter
extends FilterWriter
implements NoClose

Writer that encodes during write.

See MediaEncoder

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
EncoderWriter(Encoder encoder, Writer out)
EncoderWriter(Encoder encoder, Writer out, boolean outOptimized)

Method Summary

Modifier and Type	Method	Description
EncoderWriter	append(char c)
EncoderWriter	append(CharSequence csq)
EncoderWriter	append(CharSequence csq, int start, int end)
Encoder	getEncoder()	This method may be overridden for the purpose of covariant return, but must return encoder.
Writer	getOut()	Gets the wrapped writer, which has been optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).
boolean	isNoClose()	Determines if calls to NoClose.close() will be ignored.
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)
void	writePrefix()	See MediaEncoder.writePrefixTo(java.lang.Appendable).
void	writeSuffix()	Deprecated. Please use writeSuffix(boolean) while specifying desired trim.
void	writeSuffix(boolean trim)	See MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).

Methods inherited from class java.io.FilterWriter

close, flush

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoapps.lang.io.NoClose

close

Constructor Detail

EncoderWriter

public EncoderWriter(Encoder encoder,
                     Writer out,
                     boolean outOptimized)

Parameters:

out - Conditionally passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)

outOptimized - Is out already known to have been passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)?

EncoderWriter

public EncoderWriter(Encoder encoder,
                     Writer out)

Parameters:

out - Will be passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)

Method Detail

getEncoder

public Encoder getEncoder()

This method may be overridden for the purpose of covariant return, but must return encoder.

getOut

public Writer getOut()

Gets the wrapped writer, which has been optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder).

This method may be overridden for the purpose of covariant return, but must return FilterWriter.out.

isNoClose

public boolean isNoClose()

Description copied from interface: NoClose

Determines if calls to NoClose.close() will be ignored. This value must not change over time; it may be queried once, repeatedly, or never.

Specified by:

isNoClose in interface NoClose

writePrefix

public void writePrefix()
                 throws IOException

See MediaEncoder.writePrefixTo(java.lang.Appendable).

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Overrides:

write in class FilterWriter

Throws:

IOException

append

public EncoderWriter append(char c)
                     throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public EncoderWriter append(CharSequence csq)
                     throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

writeSuffix

@Deprecated
public final void writeSuffix()
                       throws IOException

Deprecated.

Please use writeSuffix(boolean) while specifying desired trim.

See MediaEncoder.writeSuffixTo(java.lang.Appendable).

Throws:

IOException

writeSuffix

public void writeSuffix(boolean trim)
                 throws IOException

See MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).

Parameters:

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

Throws:

IOException