Added in API level 1
Deprecated in API level 1

Summary: Fields | Ctors | Methods | Inherited Methods

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

`int`	`available()` Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
`void`	`close()` Closes this input stream and releases any system resources associated with the stream.
`void`	`mark(int readlimit)` Marks the current position in this input stream.
`boolean`	`markSupported()` Tests if this input stream supports the `mark` and `reset` methods.
`static InputStream`	`nullInputStream()` Returns a new `InputStream` that reads no bytes.
`int`	`read(byte[] b)` Reads some number of bytes from the input stream and stores them into the buffer array `b`.
`abstract int`	`read()` Reads the next byte of data from the input stream.
`int`	`read(byte[] b, int off, int len)` Reads up to `len` bytes of data from the input stream into an array of bytes.
`byte[]`	`readAllBytes()` Reads all remaining bytes from the input stream.
`int`	`readNBytes(byte[] b, int off, int len)` Reads the requested number of bytes from the input stream into the given byte array.
`byte[]`	`readNBytes(int len)` Reads up to a specified number of bytes from the input stream.
`void`	`reset()` Repositions this stream to the position at the time the `mark` method was last called on this input stream.
`long`	`skip(long n)` Skips over and discards `n` bytes of data from this input stream.
`void`	`skipNBytes(long n)` Skips over and discards exactly `n` bytes of data from this input stream.
`long`	`transferTo(OutputStream out)` Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read.

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface java.io.Closeable

abstract void

close()

Closes this stream and releases any system resources associated with it.

From interface java.lang.AutoCloseable

abstract void

close()

Closes this resource, relinquishing any underlying resources.

Fields

buffer

Added in API level 1

 protected String buffer

The string from which bytes are read.

count

Added in API level 1

 protected int count

The number of valid characters in the input stream buffer.

See also:

buffer

pos

Added in API level 1

 protected int pos

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

See also:

buffer

Public constructors

StringBufferInputStream

Added in API level 1

 public 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

 public 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

 public 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

 public 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

 public 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

 public 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.