java.io: public class: StringBufferInputStream

java.io
public class: StringBufferInputStream [javadoc | source]

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

All Implemented Interfaces:
Closeable

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.

Also see:

java.io.ByteArrayInputStream

java.io.StringReader

author: Arthur - van Hoff

since: JDK1.0 -

Field Summary
protected String	buffer	The string from which bytes are read.
protected int	pos	The index of the next character to read from the input stream buffer. Also see: java.io.StringBufferInputStream#buffer
protected int	count	The number of valid characters in the input stream buffer. Also see: java.io.StringBufferInputStream#buffer

Constructor:

Constructor:
public StringBufferInputStream(String s) { this.buffer = s; count = s.length(); } Creates a string input stream to read data from the specified string. Parameters: `s` - the underlying input buffer.

 public StringBufferInputStream(String s) {
        this.buffer = s;
        count = s.length();
}

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

Parameters:

s - the underlying input buffer.

Method from java.io.StringBufferInputStream Summary:
available, read, read, reset, skip

Methods from java.io.InputStream:
available, close, mark, markSupported, read, read, read, reset, skip

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.io.StringBufferInputStream Detail:
public synchronized int available() { return count - pos; } Deprecated! Returns the number of bytes that can be read from the input stream without blocking.
public synchronized int read() { return (pos < count) ? (buffer.charAt(pos++) & 0xFF) : -1; } Deprecated! 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.
public synchronized int read(byte[] b, int off, int len) { if (b == null) { throw new NullPointerException(); } else if ((off < 0) \|\| (off > b.length) \|\| (len < 0) \|\| ((off + len) > b.length) \|\| ((off + len) < 0)) { throw new IndexOutOfBoundsException(); } if (pos >= count) { return -1; } if (pos + len > count) { len = count - pos; } if (len < = 0) { return 0; } String s = buffer; int cnt = len; while (--cnt >= 0) { b[off++] = (byte)s.charAt(pos++); } return len; } Deprecated! 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.
public synchronized void reset() { pos = 0; } Deprecated! Resets the input stream to begin reading from the first character of this input stream's underlying buffer.
public synchronized long skip(long n) { if (n < 0) { return 0; } if (n > count - pos) { n = count - pos; } pos += n; return n; } Deprecated! Skips `n` bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached.

Method from java.io.StringBufferInputStream Detail:

 public synchronized int available() {
        return count - pos;
}

Deprecated!

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

 public synchronized int read() {
        return (pos <  count) ? (buffer.charAt(pos++) & 0xFF) : -1;
}

Deprecated!

int

0

255

-1

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

 public synchronized int read(byte[] b,
    int off,
    int len) {
        if (b == null) {
            throw new NullPointerException();
        } else if ((off <  0) || (off  > b.length) || (len <  0) ||
                   ((off + len)  > b.length) || ((off + len) <  0)) {
            throw new IndexOutOfBoundsException();
        }
        if (pos  >= count) {
            return -1;
        }
        if (pos + len  > count) {
            len = count - pos;
        }
        if (len < = 0) {
            return 0;
        }
        String  s = buffer;
        int cnt = len;
        while (--cnt  >= 0) {
            b[off++] = (byte)s.charAt(pos++);
        }
        return len;
}

Deprecated!

len

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.

 public synchronized  void reset() {
        pos = 0;
}

Deprecated!

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

 public synchronized long skip(long n) {
        if (n <  0) {
            return 0;
        }
        if (n  > count - pos) {
            n = count - pos;
        }
        pos += n;
        return n;
}

Deprecated!

n