head 1.1; branch 1.1.1; access ; symbols DEVEL:1.1.1.1 HEAD:1.1.1; locks ; strict; comment @# @; 1.1 date 2001.03.16.18.13.14; author jallali; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2001.03.16.18.13.14; author jallali; state Exp; branches ; next ; desc @@ 1.1 log @Initial revision @ text @

Overview | Package | Class | Tree | Deprecated | Index | Help
| EJCL Xtreme for PalmOS
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.io
Class FilterInputStream

    java.lang.Object
      |
      +--java.io.InputStream
            |
            +--java.io.FilterInputStream

Direct Known Subclasses:
  BufferedInputStream

public class FilterInputStream
extends InputStream

FilteredInputStream is a class which takes an input stream and filters the input in some way. The filtered view may be a buffered view or one which uncompresses data before returning bytes read. FilterInputStreams are meant for byte streams.

See Also:
  `FilterOutputStream`

Field Summary
`protected InputStream` | `in` The target InputStream which is being filtered.

Constructor Summary
`protected` | `FilterInputStream(InputStream in)` Constructs a new FilterInputStream on the InputStream `in`.

Method Summary
`int` | `available()` Answers a int representing the number of bytes that are available before this FilterInputStream will block.
`void` | `close()` Close this FilterInputStream.
`int` | `read()` Reads a single byte from this FilterInputStream and returns the result as an int.
`int` | `read(byte[] buffer, int offset, int count)` Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`.
`long` | `skip(long count)` Skips `count` number of bytes in this InputStream.

Methods inherited from class java.io.InputStream
`markSupported, read`

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### in

    protected InputStream in

  The target InputStream which is being filtered.

Constructor Detail

### FilterInputStream

    protected FilterInputStream(InputStream in)

  Constructs a new FilterInputStream on the InputStream `in`. All reads are now filtered through this stream.
  Parameters:
    `in` - The non-null InputStream to filter reads on.

Method Detail

### available

    public int available()
                  throws IOException

  Answers a int representing the number of bytes that are available before this FilterInputStream will block. This method returns the number of bytes available in the target stream.
  Overrides:
    available in class InputStream
  Returns:
    the number of bytes available before blocking.
  Throws:
    IOException - If an error occurs in this stream.

### close

    public void close()
               throws IOException

  Close this FilterInputStream. This implementation closes the target stream.
  Overrides:
    close in class InputStream
  Throws:
    IOException - If an error occurs attempting to close this stream.

### read

    public int read()
             throws IOException

  Reads a single byte from this FilterInputStream and returns the result as an int. The low-order byte is returned or -1 of the end of stream was encountered. This implementation returns a byte from the target stream.
  Overrides:
    read in class InputStream
  Returns:
    the byte read or -1 if end of stream.
  Throws:
    IOException - If the stream is already closed or another IOException occurs.

### read

    public int read(byte[] buffer,
                    int offset,
                    int count)
             throws IOException

  Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered. This implementation reads bytes from the target stream.
  Overrides:
    read in class InputStream
  Parameters:
    `buffer` - the byte array in which to store the read bytes.
    `offset` - the offset in `buffer` to store the read bytes.
    `count` - the maximum number of bytes to store in `buffer`.
  Returns:
    the number of bytes actually read or -1 if end of stream.
  Throws:
    IOException - If the stream is already closed or another IOException occurs.

### skip

    public long skip(long count)
              throws IOException

  Skips `count` number of bytes in this InputStream. Subsequent `read()`'s will not return these bytes unless `reset()` is used. This implementation skips `count` number of bytes in the target stream.
  Overrides:
    skip in class InputStream
  Parameters:
    `count` - the number of bytes to skip.
  Returns:
    the number of bytes actually skipped.
  Throws:
    IOException - If the stream is already closed or another IOException occurs.

Overview | Package | Class | Tree | Deprecated | Index | Help
| EJCL Xtreme for PalmOS
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

@ 1.1.1.1 log @import initial @ text @@