Added in API level 1

InputStreamReader

open class InputStreamReader : Reader
kotlin.Any
   ↳ java.io.Reader
   ↳ java.io.InputStreamReader

An InputStreamReader is a bridge from byte streams to character streams: It reads bytes and decodes them into characters using a specified . The charset that it uses may be specified by name or may be given explicitly, or the platform's default charset may be accepted.

Each invocation of one of an InputStreamReader's read() methods may cause one or more bytes to be read from the underlying byte-input stream. To enable the efficient conversion of bytes to characters, more bytes may be read ahead from the underlying stream than are necessary to satisfy the current read operation.

For top efficiency, consider wrapping an InputStreamReader within a BufferedReader. For example:

BufferedReader in
    = new BufferedReader(new InputStreamReader(anInputStream));
  

Summary

Public constructors

Creates an InputStreamReader that uses the default charset.

InputStreamReader(in: InputStream!, charsetName: String!)

Creates an InputStreamReader that uses the named charset.

Creates an InputStreamReader that uses the given charset.

Creates an InputStreamReader that uses the given charset decoder.

Public methods
open Unit

open String!

Returns the name of the character encoding being used by this stream.

open Int
read(target: CharBuffer!)

open Int

Reads a single character.

open Int
read(cbuf: CharArray!, off: Int, len: Int)

Reads characters into a portion of an array.

open Boolean

Tells whether this stream is ready to be read.

Inherited functions
Inherited properties

Public constructors

InputStreamReader

Added in API level 1
InputStreamReader(in: InputStream!)

Creates an InputStreamReader that uses the default charset.

Parameters
in InputStream!: An InputStream

InputStreamReader

Added in API level 1
InputStreamReader(
    in: InputStream!,
    charsetName: String!)

Creates an InputStreamReader that uses the named charset.

Parameters
in InputStream!: An InputStream
charsetName String!: The name of a supported charset
Exceptions
java.io.UnsupportedEncodingException If the named charset is not supported

InputStreamReader

Added in API level 1
InputStreamReader(
    in: InputStream!,
    cs: Charset!)

Creates an InputStreamReader that uses the given charset.

Parameters
in InputStream!: An InputStream
cs Charset!: A charset

InputStreamReader

Added in API level 1
InputStreamReader(
    in: InputStream!,
    dec: CharsetDecoder!)

Creates an InputStreamReader that uses the given charset decoder.

Parameters
in InputStream!: An InputStream
dec CharsetDecoder!: A charset decoder

Public methods

close

Added in API level 1
open fun close(): Unit
Exceptions
java.lang.Exception if this resource cannot be closed
java.io.IOException if an I/O error occurs

getEncoding

Added in API level 1
open fun getEncoding(): String!

Returns the name of the character encoding being used by this stream.

If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.

If this instance was created with the InputStreamReader(java.io.InputStream,java.lang.String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method will return null if the stream has been closed.

Return
String! The historical name of this encoding, or null if the stream has been closed

read

Added in API level 1
open fun read(target: CharBuffer!): Int
Parameters
cb the buffer to read characters into
target CharBuffer!: the buffer to read characters into
Return
Int The number of characters added to the buffer, or -1 if this source of characters is at its end
Exceptions
java.io.IOException if an I/O error occurs
java.lang.NullPointerException if target is null
java.nio.ReadOnlyBufferException if target is a read only buffer

read

Added in API level 1
open fun read(): Int

Reads a single character.

Return
Int The character read, or -1 if the end of the stream has been reached
Exceptions
java.io.IOException If an I/O error occurs

read

Added in API level 1
open fun read(
    cbuf: CharArray!,
    off: Int,
    len: Int
): Int

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.

Parameters
cbuf CharArray!: Destination buffer
off Int: Offset at which to start storing characters
len Int: Maximum number of characters to read
Return
Int The number of characters read, or -1 if the end of the stream has been reached
Exceptions
java.lang.IndexOutOfBoundsException

ready

Added in API level 1
open fun ready(): Boolean

Tells whether this stream is ready to be read. An InputStreamReader is ready if its input buffer is not empty, or if bytes are available to be read from the underlying byte stream.

Return
Boolean True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.
Exceptions
java.io.IOException If an I/O error occurs