Package com.ctc.wstx.io
Class UTF8Writer
- java.lang.Object
-
- java.io.Writer
-
- com.ctc.wstx.io.UTF8Writer
-
- All Implemented Interfaces:
CompletelyCloseable
,java.io.Closeable
,java.io.Flushable
,java.lang.Appendable
,java.lang.AutoCloseable
public final class UTF8Writer extends java.io.Writer implements CompletelyCloseable
Specialized buffering UTF-8 writer used byXmlWriter
. 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 int
DEFAULT_BUF_LEN
(package private) boolean
mAutoCloseOutput
(package private) WriterConfig
mConfig
(package private) java.io.OutputStream
mOut
(package private) byte[]
mOutBuffer
(package private) int
mOutBufferLast
(package private) int
mOutPtr
(package private) int
mSurrogate
When outputting chars from BMP, surrogate pairs need to be coalesced.(package private) static int
SURR1_FIRST
(package private) static int
SURR1_LAST
(package private) static int
SURR2_FIRST
(package private) static int
SURR2_LAST
-
Constructor Summary
Constructors Constructor Description UTF8Writer(WriterConfig cfg, java.io.OutputStream out, boolean autoclose)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
_close(boolean forceClosing)
private 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(java.lang.String str)
void
write(java.lang.String str, int off, int len)
-
-
-
Field Detail
-
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 java.io.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 Detail
-
UTF8Writer
public UTF8Writer(WriterConfig cfg, java.io.OutputStream out, boolean autoclose)
-
-
Method Detail
-
closeCompletely
public void closeCompletely() throws java.io.IOException
- Specified by:
closeCompletely
in interfaceCompletelyCloseable
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classjava.io.Writer
- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException
- Specified by:
flush
in interfacejava.io.Flushable
- Specified by:
flush
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(char[] cbuf) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(char[] cbuf, int off, int len) throws java.io.IOException
- Specified by:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(int c) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(java.lang.String str) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(java.lang.String str, int off, int len) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
_close
private final void _close(boolean forceClosing) throws java.io.IOException
- Throws:
java.io.IOException
-
_convertSurrogate
private final int _convertSurrogate(int secondPart) throws java.io.IOException
Method called to calculate UTF codepoint, from a surrogate pair.- Throws:
java.io.IOException
-
throwIllegal
private void throwIllegal(int code) throws java.io.IOException
- Throws:
java.io.IOException
-
-