: Class REFilterInputStream

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

## gnu.regexp
Class REFilterInputStream

    java.lang.Object
      |
      +--java.io.InputStream
            |
            +--java.io.FilterInputStream
                  |
                  +--gnu.regexp.REFilterInputStream

Deprecated. This class cannot properly handle all character encodings. For proper handling, use the REFilterReader class instead.

public class REFilterInputStream
extends java.io.FilterInputStream

Replaces instances of a given RE found within an InputStream with replacement text. The replacements are interpolated into the stream when a match is found.

Author:
  Wes Biggs

Constructor Summary
`REFilterInputStream(java.io.InputStream stream, RE expr, java.lang.String replace)` Deprecated. Creates an REFilterInputStream.

Method Summary
`boolean` | `markSupported()` Deprecated. Returns false.
`int` | `read()` Deprecated. Reads the next byte from the stream per the general contract of InputStream.read().
`int` | `read(byte[] b)` Deprecated. Reads from the stream into the provided array.
`int` | `read(byte[] b, int off, int len)` Deprecated. Reads from the stream into the provided array.

Methods inherited from class java.io.FilterInputStream
`available, close, mark, reset, skip`

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

Constructor Detail

### REFilterInputStream

    public REFilterInputStream(java.io.InputStream stream,
                               RE expr,
                               java.lang.String replace)

  Deprecated.
  Creates an REFilterInputStream. When reading from this stream, occurrences of patterns matching the supplied regular expression will be replaced with the supplied replacement text (the metacharacters $0 through $9 may be used to refer to the full match or subexpression matches).
  Parameters:
    `stream` - The InputStream to be filtered.
    `expr` - The regular expression to search for.
    `replace` - The text pattern to replace matches with.

Method Detail

### read

    public int read()

  Deprecated.
  Reads the next byte from the stream per the general contract of InputStream.read(). Returns -1 on error or end of stream.
  Overrides:
    `read` in class `java.io.FilterInputStream`

### markSupported

    public boolean markSupported()

  Deprecated.
  Returns false. REFilterInputStream does not support mark() and reset() methods.
  Overrides:
    `markSupported` in class `java.io.FilterInputStream`

### read

    public int read(byte[] b,
                    int off,
                    int len)

  Deprecated.
  Reads from the stream into the provided array.
  Overrides:
    `read` in class `java.io.FilterInputStream`

### read

    public int read(byte[] b)

  Deprecated.
  Reads from the stream into the provided array.
  Overrides:
    `read` in class `java.io.FilterInputStream`

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