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

Field Summary

Modifier and Type	Field and Description
private final ByteBuffer	bb
private final ReadableByteChannel	ch
private volatile boolean	closed
private final Charset	cs
private final CharsetDecoder	decoder
private static final int	DEFAULT_BYTE_BUFFER_SIZE
private boolean	haveLeftoverChar
private final InputStream	in
private char	leftoverChar
private static final int	MIN_BYTE_BUFFER_SIZE

Inherited from java.io.Reader:: lock

Constructor Summary

Access	Constructor and Description
pack-priv	StreamDecoder(InputStream in, Object lock, Charset cs)
pack-priv	StreamDecoder(InputStream in, Object lock, CharsetDecoder dec)
pack-priv	StreamDecoder(ReadableByteChannel ch, CharsetDecoder dec, int mbc)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
pack-priv String	encodingName()
private void	ensureOpen()
public void	fillZeroToPosition()
public static StreamDecoder	forDecoder(ReadableByteChannel ch, CharsetDecoder dec, int minBufferCap)
public static StreamDecoder	forInputStreamReader(InputStream in, Object lock, String charsetName)
public static StreamDecoder	forInputStreamReader(InputStream in, Object lock, Charset cs)
public static StreamDecoder	forInputStreamReader(InputStream in, Object lock, CharsetDecoder dec)
public String	getEncoding()
pack-priv void	implClose()
pack-priv int	implRead(char[] cbuf, int off, int end)
pack-priv boolean	implReady()
private boolean	inReady()
private boolean	isOpen()
public int	read() Overrides java.io.Reader.read. Reads a single character.
public int	read(char[] cbuf, int offset, int length) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.
private int	read0()
private int	readBytes()
public boolean	ready() Overrides java.io.Reader.ready. Tells whether this stream is ready to be read.

Inherited from java.io.Reader:: mark markSupported nullReader of read read readAllAsString readAllLines reset skip transferTo

Field Detail

bb	back to summary
private final ByteBuffer bb

ch	back to summary
private final ReadableByteChannel ch

closed	back to summary
private volatile boolean closed

cs	back to summary
private final Charset cs

decoder	back to summary
private final CharsetDecoder decoder

DEFAULT_BYTE_BUFFER_SIZE	back to summary
private static final int DEFAULT_BYTE_BUFFER_SIZE

haveLeftoverChar	back to summary
private boolean haveLeftoverChar

in	back to summary
private final InputStream in

leftoverChar	back to summary
private char leftoverChar

MIN_BYTE_BUFFER_SIZE	back to summary
private static final int MIN_BYTE_BUFFER_SIZE

Constructor Detail

StreamDecoder	back to summary
pack-priv StreamDecoder(InputStream in, Object lock, Charset cs)

StreamDecoder	back to summary
pack-priv StreamDecoder(InputStream in, Object lock, CharsetDecoder dec)

StreamDecoder	back to summary
pack-priv StreamDecoder(ReadableByteChannel ch, CharsetDecoder dec, int mbc)

Method Detail

close	back to summary
public void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. 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.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. 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

fillZeroToPosition	back to summary
public void fillZeroToPosition() throws IOException

forDecoder	back to summary
public static StreamDecoder forDecoder(ReadableByteChannel ch, CharsetDecoder dec, int minBufferCap)

forInputStreamReader	back to summary
public static StreamDecoder forInputStreamReader(InputStream in, Object lock, String charsetName) throws UnsupportedEncodingException

forInputStreamReader	back to summary
public static StreamDecoder forInputStreamReader(InputStream in, Object lock, Charset cs)

forInputStreamReader	back to summary
public static StreamDecoder forInputStreamReader(InputStream in, Object lock, CharsetDecoder dec)

getEncoding	back to summary
public String getEncoding()

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

implRead	back to summary
pack-priv int implRead(char[] cbuf, int off, int end) throws IOException

implReady	back to summary
pack-priv boolean implReady()

inReady	back to summary
private boolean inReady()

isOpen	back to summary
private boolean isOpen()

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. Doc from java.io.Reader.read. Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached. Subclasses that intend to support efficient single-character input should override this method. Exceptions IOException: If an I/O error occurs

read

back to summary

public int read() throws IOException

Overrides java.io.Reader.read.

Doc from java.io.Reader.read.

Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached.

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

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf, int offset, int length) throws IOException Implements abstract java.io.Reader.read. Doc from java.io.Reader.read. Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. If `len` is zero, then no characters are read and `0` is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value `-1` is returned; otherwise, at least one character is read and stored into `cbuf`. Exceptions IOException: If an I/O error occurs

public int read(char[] cbuf, int offset, int length) throws IOException

Implements abstract java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

If len is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Exceptions

IOException:: If an I/O error occurs

read0	back to summary
private int read0() throws IOException Annotations @SuppressWarnings:fallthrough

readBytes	back to summary
private int readBytes() throws IOException

ready	back to summary
public boolean ready() throws IOException Overrides java.io.Reader.ready. Doc from java.io.Reader.ready. Tells whether this stream is ready to be read. Exceptions IOException: If an I/O error occurs

ready

back to summary

public boolean ready() throws IOException

Overrides java.io.Reader.ready.

Doc from java.io.Reader.ready.

Tells whether this stream is ready to be read.

Exceptions

IOException:: If an I/O error occurs

public Class StreamDecoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail