Packages  This Package  Prev  Next  Index  
	§2.23 Class StringBufferInputStream
public  class  java.io.StringBufferInputStream
    extends  java.io.InputStream  (I-§2.13)
{
        // Fields
    protected String buffer;	§2.23.1
    protected int count;	§2.23.2
    protected int pos;	§2.23.3
        // Constructors
    public StringBufferInputStream(String  s);	§2.23.4
        // Methods
    public int available();	§2.23.5
    public int read();	§2.23.6
    public int read(byte  b[], int  off, int  len);	§2.23.7
    public void reset();	§2.23.8
    public long skip(long  n);	§2.23.9
}
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 (I-§2.3).
Only the low eight bits of each character in the string are used by this class.
buffer
protected String buffer
- The string from which bytes are read. 
 
count
protected int count
- The number of valid characters in the input stream buffer (I-§2.23.1).
 
pos
protected int pos
- The index of the next character to read from the input stream buffer 
(I-§2.23.1).
 
StringBufferInputStream
public StringBufferInputStream(String  s)
- Creates a string input stream to read data from the specified string
- Parameters:
 s
- the underlying input buffer
 
available
public int available()
- Determines the number of bytes that can be read from the input stream 
without blocking.
- Returns:
 - the value of 
, which is the number of bytes remaining to 
be read from the input buffer. 
 - Overrides:
 - available in class InputStream  (I-§2.13.2).
 
 
read
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 8 
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 reachedend of the 
stream is reached.
 - Overrides:
 - read in class InputStream  (I-§2.13.6).
 
  
read
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 8-
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 is there is no more 
data because the end of the stream has been reached.
 - Overrides:
 - read in class InputStream  (I-§2.13.8).
 
  
reset
public void reset()
- Resets the input stream to begin reading from the first character of this 
input stream's underlying buffer.
- Overrides:
 - reset in class InputStream  (I-§2.13.9).
 
 
skip
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
- the number of bytes to be skipped
- Returns:
 - the actual number of bytes skipped.
 - Overrides:
 - skip in class InputStream  (I-§2.13.10).
 
 
Packages  This Package  Prev  Next  Index
Java API Document (HTML generated by dkramer on April 22, 1996)
Copyright © 1996 Sun Microsystems, Inc.
All rights reserved
Please send any comments or corrections to doug.kramer@sun.com