Woodstox 6.5.1 · com.ctc.wstx.io.UTF8Writer · APIdia, the JavaDoc alternative

Field Summary

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

Inherited from java.io.Writer:: lock

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
private final void	_close(boolean forceClosing)
private final int	_convertSurrogate(int secondPart) Method called to calculate UTF codepoint, from a surrogate pair.
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
public void	closeCompletely() Implements com.ctc.wstx.io.CompletelyCloseable.closeCompletely.
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
private void	throwIllegal(int code)
public void	write(char[] Array of characters to be written cbuf) Overrides java.io.Writer.write. Writes an array of characters.
public void	write(char[] Array of characters cbuf, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.
public void	write(int int specifying a character to be written c) Overrides java.io.Writer.write. Writes a single character.
public void	write(String String to be written str) Overrides java.io.Writer.write. Writes a string.
public void	write(String A String str, int Offset from which to start writing characters off, int Number of characters to write len) Overrides java.io.Writer.write. Writes a portion of a string.

Inherited from java.io.Writer:: append append append nullWriter

Field Detail

DEFAULT_BUF_LEN	back to summary
private static final int DEFAULT_BUF_LEN

mAutoCloseOutput	back to summary
pack-priv final boolean mAutoCloseOutput

mConfig	back to summary
pack-priv final WriterConfig mConfig

mOut	back to summary
pack-priv final OutputStream mOut

mOutBuffer	back to summary
pack-priv byte[] mOutBuffer

mOutBufferLast	back to summary
pack-priv final int mOutBufferLast

mOutPtr	back to summary
pack-priv int mOutPtr

mSurrogate	back to summary
pack-priv 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

SURR1_FIRST	back to summary
pack-priv static final int SURR1_FIRST

SURR1_LAST	back to summary
pack-priv static final int SURR1_LAST

SURR2_FIRST	back to summary
pack-priv static final int SURR2_FIRST

SURR2_LAST	back to summary
pack-priv static final int SURR2_LAST

Constructor Detail

UTF8Writer	back to summary
public UTF8Writer(WriterConfig cfg, OutputStream out, boolean autoclose)

Method Detail

_close	back to summary
private final void _close(boolean forceClosing) throws IOException

_convertSurrogate	back to summary
private final int _convertSurrogate(int secondPart) throws IOException Method called to calculate UTF codepoint, from a surrogate pair.

close	back to summary
public void close() throws IOException Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Doc from java.io.Writer.close. Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

closeCompletely	back to summary
public void closeCompletely() throws IOException Implements com.ctc.wstx.io.CompletelyCloseable.closeCompletely. Annotations @Override

closeCompletely

back to summary

public void closeCompletely() throws IOException

Implements com.ctc.wstx.io.CompletelyCloseable.closeCompletely.

Annotations

@Override

flush	back to summary
public void flush() throws IOException Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Doc from java.io.Writer.flush. Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Writer.flush.

Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

throwIllegal	back to summary
private void throwIllegal(int code) throws IOException

write	back to summary
public void write(char[] cbuf) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes an array of characters. Parameters cbuf:char[] Array of characters to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(char[] cbuf) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes an array of characters.

Parameters

cbuf:char[]: Array of characters to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(char[] cbuf, int off, int len) throws IOException Implements abstract java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of an array of characters. Parameters cbuf:char[] Array of characters off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

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

Implements abstract java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

cbuf:char[]: Array of characters
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(int c) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored. Subclasses that intend to support efficient single-character output should override this method. Parameters c:int int specifying a character to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(int c) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored.

Subclasses that intend to support efficient single-character output should override this method.

Parameters

c:int: int specifying a character to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String str) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a string. Parameters str:String String to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(String str) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a string.

Parameters

str:String: String to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String str, int off, int len) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of a string. Parameters str:String A String off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

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

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters