public class

StringBufferInputStream

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

This class is deprecated.
Use StringReader

Class Overview

A specialized InputStream that reads bytes from a String in a sequential manner.

Summary

Fields
protected String buffer The source string containing the data to read.
protected int count The total number of characters in the source string.
protected int pos The current position within the source string.
Public Constructors
StringBufferInputStream(String str)
Construct a new StringBufferInputStream with str as source.
Public Methods
synchronized int available()
Returns the number of bytes that are available before this stream will block.
synchronized int read(byte[] b, int offset, int length)
Reads at most length bytes from the source string and stores them in the byte array b starting at offset.
synchronized int read()
Reads a single byte from the source string and returns it as an integer in the range from 0 to 255.
synchronized void reset()
Resets this stream to the beginning of the source string.
synchronized long skip(long n)
Skips n characters in the source string.
[Expand]
Inherited Methods
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Fields

protected String buffer

Since: API Level 1

The source string containing the data to read.

protected int count

Since: API Level 1

The total number of characters in the source string.

protected int pos

Since: API Level 1

The current position within the source string.

Public Constructors

public StringBufferInputStream (String str)

Since: API Level 1

Construct a new StringBufferInputStream with str as source. The size of the stream is set to the length() of the string.

Parameters
str the source string for this stream.
Throws
NullPointerException if str is null.

Public Methods

public synchronized int available ()

Since: API Level 1

Returns the number of bytes that are available before this stream will block.

Returns
  • the number of bytes available before blocking.

public synchronized int read (byte[] b, int offset, int length)

Since: API Level 1

Reads at most length bytes from the source string and stores them in the byte array b starting at offset.

Parameters
b the byte array in which to store the bytes read.
offset the initial position in b to store the bytes read from this stream.
length the maximum number of bytes to store in b.
Returns
  • the number of bytes actually read or -1 if the end of the source string has been reached.
Throws
IndexOutOfBoundsException if offset < 0 or length < 0, or if offset + length is greater than the length of b.
NullPointerException if b is null.

public synchronized int read ()

Since: API Level 1

Reads a single byte from the source string and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source string has been reached.

Returns
  • the byte read or -1 if the end of the source string has been reached.

public synchronized void reset ()

Since: API Level 1

Resets this stream to the beginning of the source string.

public synchronized long skip (long n)

Since: API Level 1

Skips n characters in the source string. It does nothing and returns 0 if n is negative. Less than n characters are skipped if the end of the source string is reached before the operation completes.

Parameters
n the number of characters to skip.
Returns
  • the number of characters actually skipped.