|
Project JXTA | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
java.io.FilterInputStream
net.jxta.util.LimitInputStream
Implements a bounds on the number of bytes which may be read from an InputStream. {link LimitInputStream.close() close()} does not close the underlying stream.
Field Summary |
Fields inherited from class java.io.FilterInputStream |
in |
Constructor Summary | |
LimitInputStream(InputStream in,
long limit)
Creates a new instance of LimitInputStream |
|
LimitInputStream(InputStream in,
long limit,
boolean underflowThrows)
Creates a new instance of LimitInputStream |
Method Summary | |
int |
available()
Returns the number of bytes that can be read from this input stream without blocking. |
void |
close()
Closes this input stream and releases any system resources associated with the stream. |
void |
mark(int readlimit)
Marks the current position in this input stream. |
int |
read()
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 |
reset()
Repositions this stream to the position at the time the mark method was last called on this input stream.
|
long |
skip(long n)
Skips over and discards n bytes of data from the
input stream. |
String |
toString()
Debugging toString. |
Methods inherited from class java.io.FilterInputStream |
markSupported, read |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public LimitInputStream(InputStream in, long limit)
in
- the stream which will be limited.limit
- the number of bytes which can be read from the stream.public LimitInputStream(InputStream in, long limit, boolean underflowThrows)
in
- the stream which will be limited.limit
- the number of bytes which can be read from the stream.underflowThrows
- if the underlying stream EOFs before limit then
an IOException will be thrown.Method Detail |
public String toString()
public void close() throws IOException
IOException
- if an I/O error occurs.FilterInputStream.in
public int available() throws IOException
This method
simply performs in.available(n)
and
returns the result.
IOException
- if an I/O error occurs.FilterInputStream.in
public void mark(int readlimit)
reset
method repositions this stream at
the last marked position so that subsequent reads re-read the same bytes.
The readlimit
argument tells this input stream to
allow that many bytes to be read before the mark position gets
invalidated.
This method simply performs in.mark(readlimit)
.
readlimit
- the maximum limit of bytes that can be read before
the mark position becomes invalid.FilterInputStream.in
,
FilterInputStream.reset()
public void reset() throws IOException
mark
method was last called on this input stream.
This method simply performs in.reset()
.
Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.
IOException
- if the stream has not been marked or if the
mark has been invalidated.FilterInputStream.in
,
FilterInputStream.mark(int)
public long skip(long n) throws IOException
n
bytes of data from the
input stream. The skip
method may, for a variety of
reasons, end up skipping over some smaller number of bytes,
possibly 0
. The actual number of bytes skipped is
returned.
This method
simply performs in.skip(n)
.
n
- the number of bytes to be skipped.
IOException
- if an I/O error occurs.public int read() throws IOException
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. This method blocks until input data
is available, the end of the stream is detected, or an exception
is thrown.
This method
simply performs in.read()
and returns the result.
-1
if the end of the
stream is reached.
IOException
- if an I/O error occurs.FilterInputStream.in
public int read(byte[] b, int off, int len) throws IOException
len
bytes of data from this input stream
into an array of bytes. This method blocks until some input is
available.
This method simply performs in.read(b, off, len)
and returns the result.
b
- the buffer into which the data is read.off
- the start offset of the data.len
- the maximum number of bytes read.
-1
if there is no more data because the end of
the stream has been reached.
IOException
- if an I/O error occurs.FilterInputStream.in
|
JXTA J2SE | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |