Package eu.bandm.tools.paisley

Class Adaptive<A>

java.lang.Object
eu.bandm.tools.paisley.AbstractPattern<A>
eu.bandm.tools.paisley.Adaptive<A>
Type Parameters:
A - the target type of the delegate pattern
All Implemented Interfaces:
Pattern<A>, Serializable, Cloneable
@Generated(generator="eu.bandm.tools.expander", version="", timestamp="2026-01-24T11:39:07") public abstract class Adaptive<A> extends AbstractPattern<A>
Abstract base class for patterns that delegate to some other pattern, chosen dynamically per target.
See Also:

  • Constructor Details

    • Adaptive

      protected Adaptive()
      Creates a new instance.

  • Method Details

    • fork

      public Pattern<A> fork()
      Makes a copy of this pattern with independent internal state.

      Subclasses must override this method if necessary to honour the following rules for all transitively reachable patterns:

      • Subpatterns that are instances of Variable must be shared. This implies that Variable.fork() must return this.
      • Fields that do not refer to subpatterns, but to matching state (changed by invocations of Pattern.match(A), Pattern.matchAgain(), Pattern.cut() or Pattern.clear()) must be duplicated. If matching state changes are effected by modification of other objects, these must be duplicated. In summary, matching operations on this pattern and its copy must not interfere, with the exception of variable bindings.
      • Fields neither referring to subpatterns nor to matching state may be either shared or duplicated. The usage of such fields in a modifiable way (such that the distinction is relevant) is strongly deprecated.
      • Patterns whose fields need not be duplicated need not be duplicated themselves, but may return this.
      Specified by:
      fork in interface Pattern<A>
      Overrides:
      fork in class AbstractPattern<A>
      Returns:
      a copy of this pattern that has independent internal state, except for variables

    • delegate

      protected abstract Pattern<? super A> delegate(A target)
      Returns a delegate pattern for the given target.
      Parameters:
      target - the object to match against
      Returns:
      the chosen delegate pattern

    • of

      public static <A> Adaptive<A> of(Function<? super A,? extends Pattern<? super A>> fun)
      Returns a pattern that delegates by the given function.
      Type Parameters:
      A - the target type of objects to match against
      Parameters:
      fun - a function to compute a delegate pattern for each target
      Returns:
      a pattern that matches any target by matching fun.apply(target)

    • match

      public boolean match(A target)
      Attempts to match this pattern against a given object.

      If the class of this pattern imposes a specific order on matches, the first one is chosen.

      The null target is generally allowed.

      Parameters:
      target - the object to match against
      Returns:
      true if the matching is successful, false if it fails. Which Variables are bound by a successful or failed match depends.
      See Also:

    • matchAgain

      public boolean matchAgain()
      Attempts to re-match this pattern against a previously matched object.

      If the class of this pattern imposes a specific order on matches, they are chosen in that order, beginning with the second one. The behaviour of this method is unspecified if the last matching attempt of this pattern has not been successful.

      Patterns classes that do not override this method are deterministic. Pattern classes that overwrite this method to provide additional matches should also override Pattern.isDeterministic().

      Returns:
      true if the matching is successful, false if it fails. Which Variables are bound by a successful match depends. The default implementation always returns false.
      See Also:

    • cut

      public void cut(boolean recursively)
      Disposes of all temporary internal state related to nondeterminism.

      The default implementation does nothing. Subclasses that override this method should also override Pattern.clear(boolean) and ensure that it implies the effect of cut(false).

      Parameters:
      recursively - true if all subpatterns should traversed, false otherwise.

    • clear

      public void clear(boolean recursively)
      Disposes of all temporary internal state related to results and nondeterminism.

      The default implementation just invokes cut(false). Subclasses that override this method should either invoke this overridden implementation, or ensure by other means that the effect of cut(false) is implied. The default implementation invokes cut(false), and delegates to body if recursively is true.

      Parameters:
      recursively - true if all subpatterns should be traversed, false otherwise.