Package org.tudalgo.algoutils.tutor.general.match

Interface Matcher<T>

Type Parameters:
T - the type of object to match
public interface Matcher<T>

A matcher is a function mapping objects to positive/negative matches.

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> Matcher<T>
    always()
    Returns an always positive-matching matcher.
    default Matcher<T>
    and(Matcher<? super T> other)
    Returns a new matcher that logically combines the current matcher with the given matcher using the logical and operator.
    <ST extends T>
    Match<ST>
    match(ST object)
    Returns a match for the given object.
    default Matcher<T>
    negate()
    returns a Matcher that matches the logical negation of this matcher.
    static <T> Matcher<T>
    never()
    Returns an always negative-matching matcher.
    default Object
    object()
     
    static <T> Matcher<T>
    of(Predicate<T> matcher)
     
    static <T> Matcher<T>
    of(Predicate<T> matcher, Object object)
     
    default Matcher<T>
    or(Matcher<T> other)
    Returns a new matcher that logically combines the current matcher with the given matcher using the logical or operator.
    default <U extends T>
    Predicate<U>
    predicate()
    returns a Predicate that returns true if the given object is matched by this matcher.

  • Method Details

    • always

      static <T> Matcher<T> always()

      Returns an always positive-matching matcher.

      Type Parameters:
      T - the type of object to match
      Returns:
      the matcher

    • never

      static <T> Matcher<T> never()

      Returns an always negative-matching matcher.

      Type Parameters:
      T - the type of object to match
      Returns:
      the matcher

    • of

      static <T> Matcher<T> of(Predicate<T> matcher, Object object)

    • of

      static <T> Matcher<T> of(Predicate<T> matcher)

    • match

      <ST extends T> Match<ST> match(ST object)

      Returns a match for the given object.

      Type Parameters:
      ST - the type of the object to match
      Parameters:
      object - the object
      Returns:
      the match

    • object

      default Object object()

    • predicate

      default <U extends T> Predicate<U> predicate()

      returns a Predicate that returns true if the given object is matched by this matcher.

      Type Parameters:
      U - the type of the object to match
      Returns:
      the predicate

    • negate

      default Matcher<T> negate()

      returns a Matcher that matches the logical negation of this matcher.

      Returns:
      the negated matcher

    • and

      default Matcher<T> and(Matcher<? super T> other)

      Returns a new matcher that logically combines the current matcher with the given matcher using the logical and operator.

      Parameters:
      other - the other matcher
      Returns:
      the new matcher

    • or

      default Matcher<T> or(Matcher<T> other)

      Returns a new matcher that logically combines the current matcher with the given matcher using the logical or operator.

      Parameters:
      other - the other matcher
      Returns:
      the new matcher