java.io
Class StringBufferInputStream

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

Deprecated.

public class StringBufferInputStream
extends InputStream

This class permits a String to be read as an input stream. The low eight bits of each character in the String are the bytes that are returned. The high eight bits of each character are discarded.

The mark/reset functionality in this class behaves differently than normal. The mark() method is always ignored and the reset() method always resets in stream to start reading from position 0 in the String. Note that since this method does not override markSupported() in InputStream, calling that method will return false.

Note that this class is deprecated because it does not properly handle 16-bit Java characters. It is provided for backwards compatibility only and should not be used for new development. The StringReader class should be used instead.


Field Summary
protected  String buffer
          Deprecated. The String which is the input to this stream.
protected  int count
          Deprecated. The length of the String buffer.
protected  int pos
          Deprecated. Position of the next byte in buffer to be read.
 
Constructor Summary
StringBufferInputStream(String s)
          Deprecated. Create a new StringBufferInputStream that will read bytes from the passed in String.
 
Method Summary
 int available()
          Deprecated. This method returns the number of bytes available to be read from this stream.
 int read()
          Deprecated. This method reads one byte from the stream.
 int read(byte[] b, int off, int len)
          Deprecated. This method reads bytes from the stream and stores them into a caller supplied buffer.
 void reset()
          Deprecated. This method sets the read position in the stream to the beginning setting the pos variable equal to 0.
 long skip(long n)
          Deprecated. This method attempts to skip the requested number of bytes in the input stream.
 
Methods inherited from class java.io.InputStream
close, mark, markSupported, read
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

buffer

protected String buffer
Deprecated. 
The String which is the input to this stream.


pos

protected int pos
Deprecated. 
Position of the next byte in buffer to be read.


count

protected int count
Deprecated. 
The length of the String buffer.

Constructor Detail

StringBufferInputStream

public StringBufferInputStream(String s)
Deprecated. 
Create a new StringBufferInputStream that will read bytes from the passed in String. This stream will read from the beginning to the end of the String.

Parameters:
s - The String this stream will read from.
Method Detail

available

public int available()
Deprecated. 
This method returns the number of bytes available to be read from this stream. The value returned will be equal to count - pos.

Overrides:
available in class InputStream
Returns:
The number of bytes that can be read from this stream before blocking, which is all of them

read

public int read()
Deprecated. 
This method reads one byte from the stream. The pos counter is advanced to the next byte to be read. The byte read is returned as an int in the range of 0-255. If the stream position is already at the end of the buffer, no byte is read and a -1 is returned in order to indicate the end of the stream.

Specified by:
read in class InputStream
Returns:
The byte read, or -1 if end of stream

read

public int read(byte[] b,
                int off,
                int len)
Deprecated. 
This method reads bytes from the stream and stores them into a caller supplied buffer. It starts storing the data at index offset into the buffer and attempts to read len bytes. This method can return before reading the number of bytes requested if the end of the stream is encountered first. The actual number of bytes read is returned. If no bytes can be read because the stream is already at the end of stream position, a -1 is returned.

This method does not block.

Overrides:
read in class InputStream
Parameters:
b - The array into which the bytes read should be stored.
off - The offset into the array to start storing bytes
len - The requested number of bytes to read
Returns:
The actual number of bytes read, or -1 if end of stream.

reset

public void reset()
Deprecated. 
This method sets the read position in the stream to the beginning setting the pos variable equal to 0. Note that this differs from the common implementation of the reset() method.

Overrides:
reset in class InputStream

skip

public long skip(long n)
Deprecated. 
This method attempts to skip the requested number of bytes in the input stream. It does this by advancing the pos value by the specified number of bytes. It this would exceed the length of the buffer, then only enough bytes are skipped to position the stream at the end of the buffer. The actual number of bytes skipped is returned.

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