# StringBufferInputStream

public class **StringBufferInputStream** extends [InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html)  


**This class is deprecated.**   
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

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayInputStream.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html`

### Field Summary

|---|---|---|
| protected [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#buffer) | The string from which bytes are read. |
| protected int | [count](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#count) | The number of valid characters in the input stream buffer. |
| protected int | [pos](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#pos) | The index of the next character to read from the input stream buffer. |

### Public Constructor Summary

|---|---|
|   | [StringBufferInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#StringBufferInputStream(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) s) Creates a string input stream to read data from the specified string. |

### Public Method Summary

|---|---|
| synchronized int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#available())() Returns the number of bytes that can be read from the input stream without blocking. |
| synchronized int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#read())() Reads the next byte of data from this input stream. |
| synchronized int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from this input stream into an array of bytes. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#reset())() Resets the input stream to begin reading from the first character of this input stream's underlying buffer. |
| synchronized long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#skip(long))(long n) Skips `n` bytes of input from this input stream. |

### Inherited Method Summary

From class [java.io.InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html)

|---|---|
| int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#available())() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#mark(int))(int readlimit) Marks the current position in this input stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods. |
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read())() Reads the next byte of data from the input stream. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from the input stream into an array of bytes. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[]))(byte\[\] b) Reads some number of bytes from the input stream and stores them into the buffer array `b`. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#reset())() Repositions this stream to the position at the time the `mark` method was last called on this input stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#skip(long))(long n) Skips over and discards `n` bytes of data from this input stream. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Fields

#### protected [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**buffer**

The string from which bytes are read.

#### protected int
**count**

The number of valid characters in the input stream buffer.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#buffer`

#### protected int
**pos**

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

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringBufferInputStream.html#buffer`

## Public Constructors

#### public
**StringBufferInputStream**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) s)

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

##### Parameters

| s | the underlying input buffer. |
|---|---|

## Public Methods

#### public synchronized int
**available**
()

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

##### Returns

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

#### public synchronized 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

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

#### public synchronized 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 | the buffer into which the data is read. |
| off | the start offset of the data. |
| len | the maximum number of bytes read. |
|---|---|

##### Returns

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

#### public synchronized void
**reset**
()

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

#### public synchronized 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 | the number of bytes to be skipped. |
|---|---|

##### Returns

- the actual number of bytes skipped.