This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.io
class StringBufferInputStream

java.lang.Object extended by java.io.InputStream extended by java.io.StringBufferInputStream
All Implemented Interfaces:
Closeable

Most common way to construct:

String s1 = …;

StringBufferInputStream in = new StringBufferInputStream(s1);

Based on 34 examples


public class StringBufferInputStream
extends InputStream

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 (auto-generated):

InputStream

File

BufferedReader


Field Summary
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.
 
Constructor Summary

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

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

          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

          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.
 
Methods inherited from class java.io.InputStream
available, close, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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.

pos

protected int pos
The index of the next character to read from the input stream buffer.
Constructor Detail

StringBufferInputStream

public StringBufferInputStream(String s)
Creates a string input stream to read data from the specified string.

Parameters:
s - the underlying input buffer.
Method Detail

available

public synchronized int available()
Returns the number of bytes that can be read from the input stream without blocking.

Overrides:
available in class InputStream
Returns:
the value of count - pos, which is the number of bytes remaining to be read from the input buffer.

read

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.

Overrides:
read in class InputStream
Returns:
the next byte of data, or -1 if the end of the stream is reached.

read

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.

Overrides:
read in class InputStream
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.

reset

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

skip

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.

Overrides:
skip in class InputStream
Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.