Package com.ctc.wstx.io

Class UTF8Writer

java.lang.Object

java.io.Writer

com.ctc.wstx.io.UTF8Writer

All Implemented Interfaces:

CompletelyCloseable, Closeable, Flushable, Appendable, AutoCloseable

public final class UTF8Writer
extends Writer
implements CompletelyCloseable

Specialized buffering UTF-8 writer used by XmlWriter. The main reason for custom version is to allow for efficient buffer recycling; the second benefit is that encoder has less overhead for short content encoding (compared to JDK default codecs).

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_BUF_LEN
(package private) final boolean	mAutoCloseOutput
(package private) final WriterConfig	mConfig
(package private) final OutputStream	mOut
(package private) byte[]	mOutBuffer
(package private) final int	mOutBufferLast
(package private) int	mOutPtr
(package private) int	mSurrogate	When outputting chars from BMP, surrogate pairs need to be coalesced.
(package private) static final int	SURR1_FIRST
(package private) static final int	SURR1_LAST
(package private) static final int	SURR2_FIRST
(package private) static final int	SURR2_LAST

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
UTF8Writer(WriterConfig cfg, OutputStream out, boolean autoclose)

Method Summary

Modifier and Type	Method	Description
private final void	_close(boolean forceClosing)
private final int	_convertSurrogate(int secondPart)	Method called to calculate UTF codepoint, from a surrogate pair.
void	close()
void	closeCompletely()
void	flush()
private void	throwIllegal(int code)
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)

Methods inherited from class java.io.Writer

append, append, append, nullWriter

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BUF_LEN

private static final int DEFAULT_BUF_LEN

See Also:

• Constant Field Values

SURR1_FIRST

static final int SURR1_FIRST

See Also:

• Constant Field Values

SURR1_LAST

static final int SURR1_LAST

See Also:

• Constant Field Values

SURR2_FIRST

static final int SURR2_FIRST

See Also:

• Constant Field Values

SURR2_LAST

static final int SURR2_LAST

See Also:

• Constant Field Values

mConfig

final WriterConfig mConfig

mAutoCloseOutput

final boolean mAutoCloseOutput

mOut

final OutputStream mOut

mOutBuffer

byte[] mOutBuffer

mOutBufferLast

final int mOutBufferLast

mOutPtr

int mOutPtr

mSurrogate

int mSurrogate

When outputting chars from BMP, surrogate pairs need to be coalesced. To do this, both pairs must be known first; and since it is possible pairs may be split, we need temporary storage for the first half

Constructor Details

UTF8Writer

public UTF8Writer(WriterConfig cfg,
 OutputStream out,
 boolean autoclose)

Method Details

closeCompletely

public void closeCompletely()
                     throws IOException

Specified by:

closeCompletely in interface CompletelyCloseable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close 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

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

Specified by:

write in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

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 Writer

Throws:

IOException

_close

private final void _close(boolean forceClosing)
                   throws IOException

Throws:

IOException

_convertSurrogate

private final int _convertSurrogate(int secondPart)
                             throws IOException

Method called to calculate UTF codepoint, from a surrogate pair.

Throws:

IOException

throwIllegal

private void throwIllegal(int code)
                   throws IOException

Throws:

IOException