OpenJDK 27 · sun.nio.cs.StreamEncoder · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private ByteBuffer	bb
private volatile boolean	closed
private final Charset	cs
private final CharsetEncoder	encoder
private boolean	haveLeftoverChar
private static final int	INITIAL_BYTE_BUFFER_CAPACITY
private CharBuffer	lcb
private char	leftoverChar
private static final int	MAX_BYTE_BUFFER_CAPACITY
private final int	maxBufferCapacity
private final OutputStream	out

Access	Constructor and Description
private	StreamEncoder(OutputStream out, Object lock, Charset cs)
private	StreamEncoder(OutputStream out, Object lock, CharsetEncoder enc)
private	StreamEncoder(OutputStream out, CharsetEncoder enc)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
pack-priv String	encodingName()
private void	ensureOpen()
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
public void	flushBuffer()
private void	flushLeftoverChar(CharBuffer cb, boolean endOfInput)
public static StreamEncoder	forOutputStreamWriter(OutputStream out, Object lock, String charsetName)
public static StreamEncoder	forOutputStreamWriter(OutputStream out, Object lock, Charset cs)
public static StreamEncoder	forOutputStreamWriter(OutputStream out, Object lock, CharsetEncoder enc)
public static StreamEncoder	forOutputStreamWriter(OutputStream out, CharsetEncoder enc)
public String	getEncoding()
pack-priv void	growByteBufferIfNeeded(int len) Grows bb to a capacity to allow len characters be encoded.
pack-priv void	implClose()
pack-priv void	implFlush()
pack-priv void	implFlushBuffer()
pack-priv void	implWrite(char[] cbuf, int off, int len)
pack-priv void	implWrite(CharBuffer cb)
private boolean	isOpen()
public void	write(int c) Overrides java.io.Writer.write. Writes a single character.
public void	write(char[] cbuf, int off, int len) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.
public void	write(String str, int off, int len) Overrides java.io.Writer.write. Writes a portion of a string.
public void	write(CharBuffer cb)
private void	writeBytes()

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

bb	back to summary
private ByteBuffer bb

closed	back to summary
private volatile boolean closed

cs	back to summary
private final Charset cs

encoder	back to summary
private final CharsetEncoder encoder

haveLeftoverChar	back to summary
private boolean haveLeftoverChar

INITIAL_BYTE_BUFFER_CAPACITY	back to summary
private static final int INITIAL_BYTE_BUFFER_CAPACITY

lcb	back to summary
private CharBuffer lcb

leftoverChar	back to summary
private char leftoverChar

MAX_BYTE_BUFFER_CAPACITY	back to summary
private static final int MAX_BYTE_BUFFER_CAPACITY

maxBufferCapacity	back to summary
private final int maxBufferCapacity

out	back to summary
private final OutputStream out

StreamEncoder	back to summary
private StreamEncoder(OutputStream out, Object lock, Charset cs)

StreamEncoder	back to summary
private StreamEncoder(OutputStream out, Object lock, CharsetEncoder enc)

StreamEncoder	back to summary
private StreamEncoder(OutputStream out, CharsetEncoder enc)

Method Detail

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. 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.

Exceptions

IOException:: If an I/O error occurs

encodingName	back to summary
pack-priv String encodingName()

ensureOpen	back to summary
private void ensureOpen() throws IOException

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. 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.

Exceptions

IOException:: If an I/O error occurs

flushBuffer	back to summary
public void flushBuffer() throws IOException

flushLeftoverChar	back to summary
private void flushLeftoverChar(CharBuffer cb, boolean endOfInput) throws IOException

forOutputStreamWriter	back to summary
public static StreamEncoder forOutputStreamWriter(OutputStream out, Object lock, String charsetName) throws UnsupportedEncodingException

forOutputStreamWriter	back to summary
public static StreamEncoder forOutputStreamWriter(OutputStream out, Object lock, Charset cs)

forOutputStreamWriter	back to summary
public static StreamEncoder forOutputStreamWriter(OutputStream out, Object lock, CharsetEncoder enc)

forOutputStreamWriter	back to summary
public static StreamEncoder forOutputStreamWriter(OutputStream out, CharsetEncoder enc)

getEncoding	back to summary
public String getEncoding()

growByteBufferIfNeeded	back to summary
pack-priv void growByteBufferIfNeeded(int len) throws IOException Grows bb to a capacity to allow len characters be encoded.

implClose	back to summary
pack-priv void implClose() throws IOException

implFlush	back to summary
pack-priv void implFlush() throws IOException

implFlushBuffer	back to summary
pack-priv void implFlushBuffer() throws IOException

implWrite	back to summary
pack-priv void implWrite(char[] cbuf, int off, int len) throws IOException

implWrite	back to summary
pack-priv void implWrite(CharBuffer cb) throws IOException

isOpen	back to summary
private boolean isOpen()

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. 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.

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. 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.

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. 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.

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(CharBuffer cb) throws IOException

writeBytes	back to summary
private void writeBytes() throws IOException

public final Class StreamEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail