Package com.saxonica.ee.stream.feed

## Interface FilteringFeed.Filter

- All Known Implementing Classes:
    `FilteringFeed.OpaqueFilter`, `FilteringFeed.TransparentFilter`, `SubsequenceStreamer.SubsequenceFilter`
  Enclosing class:
    FilteringFeed

      public static interface FilteringFeed.Filter

  Interface defining the filter function, to be implemented by the caller

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static int` | `DONE` |
    `static int` | `MATCHES` |
    `static int` | `SKIP` |

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `int` | `matches​(Item item, int position)` | Test whether a given item, at a given position in the sequence, matches the filter

- - ### Field Detail

    - #### SKIP

          static final int SKIP

      See Also:
        Constant Field Values

    - #### MATCHES

          static final int MATCHES

      See Also:
        Constant Field Values

    - #### DONE

          static final int DONE

      See Also:
        Constant Field Values

  - ### Method Detail

    - #### matches

          int matches​(Item item,
                      int position)
               throws XPathException

      Test whether a given item, at a given position in the sequence, matches the filter
      Parameters:
        `item` - the item to be matched
        `position` - the 1-based position of the item in the sequence
      Returns:
        MATCHES if the item is to be included in the result, SKIP if it is to be excluded; DONE if this and all future items are to be excluded
      Throws:
        `XPathException` - if a dynamic error occurs