to top

Summary: Fields | Ctors | Methods | Inherited Methods | [Expand All]

Since: API Level 1

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 an estimated number of bytes that can be read or skipped without blocking for more input.
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 int	read(byte[] buffer, 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 void	reset() Resets this stream to the beginning of the source string.
synchronized long	skip(long charCount) Skips `charCount` characters in the source string.

[Expand]

Inherited Methods

From class java.io.InputStream

int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this stream.
void	mark(int readlimit) Sets a mark position in this InputStream.
boolean	markSupported() Indicates whether this stream supports the `mark()` and `reset()` methods.
int	read(byte[] buffer) Equivalent to `read(buffer, 0, buffer.length)`.
abstract int	read() Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer, int offset, int length) Reads at most `length` bytes from this stream and stores them in the byte array `b` starting at `offset`.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips at most `n` bytes in this stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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 an estimated number of bytes that can be read or skipped without blocking for more input.

Note that this method provides such a weak guarantee that it is not very useful in practice.

Firstly, the guarantee is "without blocking for more input" rather than "without blocking": a read may still block waiting for I/O to complete — the guarantee is merely that it won't have to wait indefinitely for data to be written. The result of this method should not be used as a license to do I/O on a thread that shouldn't be blocked.

Secondly, the result is a conservative estimate and may be significantly smaller than the actual number of bytes available. In particular, an implementation that always returns 0 would be correct. In general, callers should only use this method if they'd be satisfied with treating the result as a boolean yes or no answer to the question "is there definitely data ready?".

Thirdly, the fact that a given number of bytes is "available" does not guarantee that a read or skip will actually read or skip that many bytes: they may read or skip fewer.

It is particularly important to realize that you must not use this method to size a container and assume that you can read the entirety of the stream without needing to resize the container. Such callers should probably write everything they read to a ByteArrayOutputStream and convert that to a byte array. Alternatively, if you're reading from a file, length() returns the current length of the file (though assuming the file's length can't change may be incorrect, reading a file is inherently racy).

The default implementation of this method in InputStream always returns 0. Subclasses should override this method if they are able to indicate the number of bytes available.

Returns

the estimated number of bytes available

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 int read (byte[] buffer, 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

buffer	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 void reset ()

Since: API Level 1

Resets this stream to the beginning of the source string.

public synchronized long skip (long charCount)

Since: API Level 1

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

Parameters

charCount	the number of bytes to skip.

Returns

the number of characters actually skipped.

Results

Interfaces

Classes

Exceptions

Errors

StringBufferInputStream

Class Overview

Summary

Fields

protected String buffer

protected int count

protected int pos

Public Constructors

public StringBufferInputStream (String str)

Parameters

Throws

Public Methods

public synchronized int available ()

Returns

public synchronized int read ()

Returns

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

Parameters

Returns

Throws

public synchronized void reset ()

public synchronized long skip (long charCount)

Parameters

Returns