gnu.xml.dom.ls
Class ReaderInputStream
- AutoCloseable, Closeable
Character stream wrapper.
int | available() - Returns conservative number of bytes available without blocking.
|
void | close() - This method closes the stream.
|
void | mark(int limit) - This method marks a position in the input to which the stream can
be "reset" by calling the
reset() method.
|
boolean | markSupported() - This method returns a boolean that indicates whether the mark/reset
methods are supported in this class.
|
int | read() - This method reads an unsigned byte from the input stream and returns it
as an int in the range of 0-255.
|
int | read(byte[] b) - This method reads bytes from a stream and stores them into a caller
supplied buffer.
|
int | read(byte[] b, int off, int len) - This method read bytes from a stream and stores them into a
caller supplied buffer.
|
void | reset() - This method resets a stream to the point where the
mark() method was called.
|
long | skip(long n) - This method skips the specified number of bytes in the stream.
|
String | toString() - Convert this Object to a human-readable String.
|
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
available
public int available()
throws IOException
Returns conservative number of bytes available without blocking.
Actual number of bytes that can be read without blocking might
be (much) bigger.
- available in interface InputStream
close
public void close()
throws IOException
This method closes the stream. Any futher attempts to read from the
stream may generate an
IOException
This method does nothing in this class, but subclasses may override
this method in order to provide additional functionality.
- close in interface Closeable
- close in interface AutoCloseable
- close in interface InputStream
IOException
- If an error occurs, which can only happen
in a subclass
mark
public void mark(int limit)
This method marks a position in the input to which the stream can
be "reset" by calling the
reset()
method. The
parameter @code{readlimit} is the number of bytes that can be read
from the stream after setting the mark before the mark becomes
invalid. For example, if
mark()
is called with a
read limit of 10, then when 11 bytes of data are read from the
stream before the
reset()
method is called, then the
mark is invalid and the stream object instance is not required to
remember the mark.
This method does nothing in this class, but subclasses may override it
to provide mark/reset functionality.
- mark in interface InputStream
markSupported
public boolean markSupported()
This method returns a boolean that indicates whether the mark/reset
methods are supported in this class. Those methods can be used to
remember a specific point in the stream and reset the stream to that
point.
This method always returns
false
in this class, but
subclasses can override this method to return
true
if they support mark/reset functionality.
- markSupported in interface InputStream
true
if mark/reset functionality is
supported, false
otherwise
read
public int read()
throws IOException
This method reads an unsigned byte from the input stream and returns it
as an int in the range of 0-255. This method also will return -1 if
the end of the stream has been reached.
This method will block until the byte can be read.
- read in interface InputStream
- The byte read or -1 if end of stream
read
public int read(byte[] b)
throws IOException
This method reads bytes from a stream and stores them into a caller
supplied buffer. This method attempts to completely fill the buffer,
but can return before doing so. The actual number of bytes read is
returned as an int. A -1 is returned to indicate the end of the stream.
This method will block until some data can be read.
This method operates by calling an overloaded read method like so:
read(b, 0, b.length)
- read in interface InputStream
b
- The buffer into which the bytes read will be stored.
- The number of bytes read or -1 if end of stream.
read
public int read(byte[] b,
int off,
int len)
throws IOException
This method read bytes from a stream and stores them into a
caller supplied buffer. It starts storing the data at index
off
into the buffer and attempts to read
len
bytes. This method can return before reading the
number of bytes requested. The actual number of bytes read is
returned as an int. A -1 is returned to indicate the end of the
stream.
This method will block until some data can be read.
This method operates by calling the single byte
read()
method
in a loop until the desired number of bytes are read. The read loop
stops short if the end of the stream is encountered or if an IOException
is encountered on any read operation except the first. If the first
attempt to read a bytes fails, the IOException is allowed to propagate
upward. And subsequent IOException is caught and treated identically
to an end of stream condition. Subclasses can (and should if possible)
override this method to provide a more efficient implementation.
- read in interface InputStream
b
- The array into which the bytes read should be storedoff
- The offset into the array to start storing byteslen
- The requested number of bytes to read
- The actual number of bytes read, or -1 if end of stream.
reset
public void reset()
throws IOException
This method resets a stream to the point where the
mark()
method was called. Any bytes that were read
after the mark point was set will be re-read during subsequent
reads.
This method always throws an IOException in this class, but subclasses
can override this method if they provide mark/reset functionality.
- reset in interface InputStream
skip
public long skip(long n)
throws IOException
This method skips the specified number of bytes in the stream. It
returns the actual number of bytes skipped, which may be less than the
requested amount.
This method reads and discards bytes into a byte array until the
specified number of bytes were skipped or until either the end of stream
is reached or a read attempt returns a short count. Subclasses can
override this metho to provide a more efficient implementation where
one exists.
- skip in interface InputStream
n
- The requested number of bytes to skip
- The actual number of bytes skipped.
toString
public String toString()
Convert this Object to a human-readable String.
There are no limits placed on how long this String
should be or what it should contain. We suggest you
make it as intuitive as possible to be able to place
it into
System.out.println()
and such.
It is typical, but not required, to ensure that this method
never completes abruptly with a
RuntimeException
.
This method will be called when performing string
concatenation with this object. If the result is
null
, string concatenation will instead
use
"null"
.
The default implementation returns
getClass().getName() + "@" +
Integer.toHexString(hashCode())
.
- toString in interface Object
- the String representing this Object, which may be null
ReaderInputStream.java --
Copyright (C) 1999, 2000, 2001, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.