| java.lang.Object
 java.io.Reader
com.Ostermiller.util.StraightStreamReader
| StraightStreamReader | | public class StraightStreamReader extends Reader (Code) | | A StraightStreamReader is a bridge from byte streams to character streams: It reads bytes
and translates them into characters without using a character encoding. The characters
that a StraightStreamReader returns may not be valid Unicode characters but they are
guaranteed to be in the 0x00 to 0xFF range.
More information about this class is available from ostermiller.org.
Most of the time you want to do character encoding translation when translating bytes to
characters. If you are planning on displaying the text, you should always do this and should
use an InputStreamReader for the purpose. Sometimes it is useful to treat characters as bytes
with some extra bits. In these cases you would want to use a StraightStreamReader.
For top efficiency, consider wrapping an StraightStreamReader within a BufferedReader. For example:
BufferedReader in = new BufferedReader(new StraightStreamReader(System.in));
author:
Stephen Ostermiller http://ostermiller.org/contact.pl?regarding=Java+Utilities
since:
ostermillerutils 1.00.00 |
| Method Summary | |
| public void | close()
Close the stream. | | public void | mark(int readAheadLimit)
Mark the present position in the stream. | | public boolean | markSupported()
Tell whether this stream supports the mark() operation. | | public int | read()
Read a single character. | | public int | read(char[] cbuf)
Read characters into an array. | | public int | read(char[] cbuf, int off, int len)
Read characters into an array. | | public boolean | ready()
Tell whether this stream is ready to be read. | | public void | reset()
Reset the stream. | | public long | skip(long n)
Skip characters. |
| StraightStreamReader | | public StraightStreamReader(InputStream in)(Code) | | Create a StraightStreamReader from an InputStream
Parameters:
in - InputStream to wrap a Reader around.
since:
ostermillerutils 1.00.00 |
| close | | public void close() throws IOException(Code) | | Close the stream.
throws:
IOException - If an I/O error occurs
since:
ostermillerutils 1.00.00 |
| mark | | public void mark(int readAheadLimit) throws IOException(Code) | | Mark the present position in the stream. Subsequent calls to reset()
will attempt to reposition the stream to this point. Not all
character-input streams support the mark() operation.
Parameters:
readAheadLimit - Limit on the number of characters that may be readwhile still preserving the mark. After reading this many characters,attempting to reset the stream may fail.
throws:
IOException - If the stream does not support mark(), or if some other I/O error occurs
since:
ostermillerutils 1.00.00 |
| markSupported | | public boolean markSupported()(Code) | | Tell whether this stream supports the mark() operation.
true if and only if this stream supports the mark operation.
since:
ostermillerutils 1.00.00 |
| read | | public int read() throws IOException(Code) | | Read a single character. This method will block until a character is available, an
I/O error occurs, or the end of the stream is reached.
The character read, as an integer in the range 0 to 256 (0x00-0xff), or -1 ifthe end of the stream has been reached
throws:
IOException - If an I/O error occurs
since:
ostermillerutils 1.00.00 |
| read | | public int read(char[] cbuf) throws IOException(Code) | | Read characters into an array. This method will block until some input is available,
an I/O error occurs, or the end of the stream is reached.
Parameters:
cbuf - Destination buffer The number of bytes read, or -1 if the end of the stream has been reached
throws:
IOException - If an I/O error occurs
since:
ostermillerutils 1.00.00 |
| read | | public int read(char[] cbuf, int off, int len) throws IOException(Code) | | Read characters into an array. This method will block until some input is available,
an I/O error occurs, or the end of the stream is reached.
Parameters:
cbuf - Destination buffer
Parameters:
off - Offset at which to start storing characters
Parameters:
len - Maximum number of characters to read The number of bytes read, or -1 if the end of the stream has been reached
throws:
IOException - If an I/O error occurs
since:
ostermillerutils 1.00.00 |
| ready | | public boolean ready() throws IOException(Code) | | Tell whether this stream is ready to be read.
True if the next read() is guaranteed not to block for input, false otherwise.Note that returning false does not guarantee that the next read will block.
throws:
IOException - If an I/O error occurs
since:
ostermillerutils 1.00.00 |
| reset | | public void reset() throws IOException(Code) | | Reset the stream. If the stream has been marked, then attempt to reposition it at the mark.
If the stream has not been marked, then attempt to reset it in some way appropriate to the
particular stream, for example by repositioning it to its starting point. Not all
character-input streams support the reset() operation, and some support reset()
without supporting mark().
throws:
IOException - If the stream has not been marked, or if the mark has been invalidated,or if the stream does not support reset(), or if some other I/O error occurs
since:
ostermillerutils 1.00.00 |
| skip | | public long skip(long n) throws IOException(Code) | | Skip characters. This method will block until some characters are available,
an I/O error occurs, or the end of the stream is reached.
Parameters:
n - The number of characters to skip The number of characters actually skipped
throws:
IllegalArgumentException - If n is negative
throws:
IOException - If an I/O error occurs
since:
ostermillerutils 1.00.00 |
|
|