Most visited

Recently visited

Added in API level 1
Deprecated since API level 1

StringBufferInputStream

public class StringBufferInputStream
extends InputStream

java.lang.Object
   ↳ java.io.InputStream
     ↳ java.io.StringBufferInputStream


This class was deprecated in API level 1.
This class does not properly convert characters into bytes. As of JDK 1.1, the preferred way to create a stream from a string is via the StringReader class.

This class allows an application to create an input stream in which the bytes read are supplied by the contents of a string. Applications can also read bytes from a byte array by using a ByteArrayInputStream.

Only the low eight bits of each character in the string are used by this class.

See also:

Summary

Fields

protected String buffer

The string from which bytes are read.

protected int count

The number of valid characters in the input stream buffer.

protected int pos

The index of the next character to read from the input stream buffer.

Public constructors

StringBufferInputStream(String s)

Creates a string input stream to read data from the specified string.

Public methods

int available()

Returns the number of bytes that can be read from the input stream without blocking.

int read()

Reads the next byte of data from this input stream.

int read(byte[] b, int off, int len)

Reads up to len bytes of data from this input stream into an array of bytes.

void reset()

Resets the input stream to begin reading from the first character of this input stream's underlying buffer.

long skip(long n)

Skips n bytes of input from this input stream.

Inherited methods

From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Fields

buffer

Added in API level 1
String buffer

The string from which bytes are read.

count

Added in API level 1
int count

The number of valid characters in the input stream buffer.

See also:

pos

Added in API level 1
int pos

The index of the next character to read from the input stream buffer.

See also:

Public constructors

StringBufferInputStream

Added in API level 1
StringBufferInputStream (String s)

Creates a string input stream to read data from the specified string.

Parameters
s String: the underlying input buffer.

Public methods

available

Added in API level 1
int available ()

Returns the number of bytes that can be read from the input stream without blocking.

Returns
int the value of count - pos, which is the number of bytes remaining to be read from the input buffer.

read

Added in API level 1
int read ()

Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned.

The read method of StringBufferInputStream cannot block. It returns the low eight bits of the next character in this input stream's buffer.

Returns
int the next byte of data, or -1 if the end of the stream is reached.

read

Added in API level 1
int read (byte[] b, 
                int off, 
                int len)

Reads up to len bytes of data from this input stream into an array of bytes.

The read method of StringBufferInputStream cannot block. It copies the low eight bits from the characters in this input stream's buffer into the byte array argument.

Parameters
b byte: the buffer into which the data is read.
off int: the start offset of the data.
len int: the maximum number of bytes read.
Returns
int the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

reset

Added in API level 1
void reset ()

Resets the input stream to begin reading from the first character of this input stream's underlying buffer.

skip

Added in API level 1
long skip (long n)

Skips n bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached.

Parameters
n long: the number of bytes to be skipped.
Returns
long the actual number of bytes skipped.

Hooray!