Package eu.bandm.tools.paisley

Class Filter<A>

java.lang.Object
eu.bandm.tools.paisley.AbstractPattern<A>
eu.bandm.tools.paisley.Unary<A,A>
eu.bandm.tools.paisley.Transform<A,A>
eu.bandm.tools.paisley.RestrictedTransform<A,A>
eu.bandm.tools.paisley.Filter<A>
Type Parameters:
A - the target type of objects to match against
All Implemented Interfaces:
Pattern<A>, Serializable, Cloneable
@Generated(generator="eu.bandm.tools.expander", version="1.3.1", timestamp="2026-02-18T13:05:43") public abstract class Filter<A> extends RestrictedTransform<A,A>
Abstract base class for patterns that match only a subset of the target type.

Subclasses should override the RestrictedTransform.isDomain(A) method. The default always returns true, performing no filtering.

See Also:

  • Constructor Details

    • Filter

      protected Filter(Pattern<? super A> body)
      Creates a new pattern.
      Parameters:
      body - the pattern to match under the restriction implemented by this filter
      Throws:
      NullPointerException - if body is null

  • Method Details

    • of

      public static <A> Filter<A> of(Predicate<? super A> pred, Pattern<? super A> body)
      Returns a filter pattern with the given domain predicate and subpattern.
      Type Parameters:
      A - the target type of objects to match against
      Parameters:
      pred - a predicate that determines whether a given target is supported by this filter
      body - a subpattern to match supported targets against
      Returns:
      a pattern that matches body against a target if isDomain returns true, or fails otherwise
      Throws:
      NullPointerException - if pred or body is null
      See Also:

    • with

      public static <A> Motif<A,A> with(Predicate<? super A> pred)
      Returns a motif that acts as a filter pattern with the given domain predicate and a hole in place of the subpattern.
      Type Parameters:
      A - the target type of objects to match against
      Parameters:
      pred - a predicate that determines whether a given target is supported by this filter
      Returns:
      a motif that matches the hole against a target if isDomain returns true, or fails otherwise
      Throws:
      NullPointerException - if pred is null
      See Also:

    • apply

      public final A apply(A target)
      Transforms a target to be matched into a target for the subpattern.

      This implementations returns target.

      Specified by:
      apply in class Transform<A,A>
      Parameters:
      target - the target for this pattern to be matched against.
      Returns:
      a target for Unary.body to be matched against.