Package VASSAL.counters

Interface PieceFilter

All Known Implementing Classes:
BeanShellExpression.BshFilter, BooleanAndPieceFilter, BooleanOrPieceFilter, CounterDetailViewer.Filter, Inventory.Selector, PropertyExpression, RangeFilter
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface PieceFilter
A filter for GamePieces Sample implementations include: PropertyExpression - used for "matching expressions" in Global Key Commands and the like RangeFilter - filters for pieces within range of a point BooleanOrPieceFilter - "OR"s two Filters together to make one Amazing Disjunctive Filter BooleanAndPieceFilter - "AND"s two Filters together and you'd better satisfy both CounterDetailViewer.Filter - Filter created from Mouseover Stack Viewer settings Inventory.Selector - Layered filter for Piece Inventory window

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    accept(GamePiece piece)
    Test if a piece matches the filter.
    default boolean
    accept(GamePiece piece, Auditable owner, String fieldKey)
    Test if a piece matches the filter and provide Expression auditing facilities
    default boolean
    accept(GamePiece piece, Auditable owner, AuditTrail audit)
    Test if a piece matches the filter and provide Expression auditing facilities

  • Method Details

    • accept

      boolean accept(GamePiece piece)
      Test if a piece matches the filter. This sig should only be used for filters that can not have Expressions as a component of the filter and thus have no Expression Auditing requirementts
      Parameters:
      piece - piece
      Returns:
      true if piece match filter

    • accept

      default boolean accept(GamePiece piece, Auditable owner, String fieldKey)
      Test if a piece matches the filter and provide Expression auditing facilities
      Parameters:
      piece - piece to test
      owner - owner of the filter
      fieldKey - EMesage key of the field holding the filter expression
      Returns:

    • accept

      default boolean accept(GamePiece piece, Auditable owner, AuditTrail audit)
      Test if a piece matches the filter and provide Expression auditing facilities
      Parameters:
      piece - piece to test
      owner - owner of the filter
      audit - Audit Trail to record evaluation of the filter
      Returns: