Java™ Platform
Standard Ed. 6

java.io
Class StringBufferInputStream

java.lang.Object
  extended by java.io.InputStream
      extended by 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.

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

Since:
JDK1.0
See Also:
ByteArrayInputStream, StringReader

Field Summary
protected  String buffer
          Deprecated. The string from which bytes are read.
protected  int count
          Deprecated. The number of valid characters in the input stream buffer.
protected  int pos
          Deprecated. The index of the next character to read from the input stream buffer.
 
Constructor Summary
StringBufferInputStream(String s)
          Deprecated. Creates a string input stream to read data from the specified string.
 
Method Summary
 int available()
          Deprecated. Returns the number of bytes that can be read from the input stream without blocking.
 int read()
          Deprecated. Reads the next byte of data from this input stream.
 int read(byte[] b, int off, int len)
          Deprecated. Reads up to len bytes of data from this input stream into an array of bytes.
 void reset()
          Deprecated. Resets the input stream to begin reading from the first character of this input stream's underlying buffer.
 long skip(long n)
          Deprecated. Skips n bytes of input from this 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 from which bytes are read.


pos

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

See Also:
buffer

count

protected int count
Deprecated. 
The number of valid characters in the input stream buffer.

See Also:
buffer
Constructor Detail

StringBufferInputStream

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

Parameters:
s - the underlying input buffer.
Method Detail

read

public int read()
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.

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

read

public int read(byte[] b,
                int off,
                int 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.

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.
See Also:
InputStream.read()

skip

public long skip(long 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.

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

available

public int available()
Deprecated. 
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.

reset

public void reset()
Deprecated. 
Resets the input stream to begin reading from the first character of this input stream's underlying buffer.

Overrides:
reset in class InputStream
See Also:
InputStream.mark(int), IOException

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.