Interface RuleStore

All Known Implementing Classes:
SimpleRuleStore

public interface RuleStore
As its name indicates, a RuleStore contains 2-tuples consists of a ElementSelector and an Action.

As a joran configurator goes through the elements in a document, it asks the rule store whether there are rules matching the current pattern by invoking the matchActions(ElementPath) method.

Author:
Ceki Gülcü
  • Method Details

    • addRule

      void addRule(ElementSelector elementSelector, String actionClassStr) throws ClassNotFoundException
      Add a new rule, given by a pattern and an action class (String).
      Parameters:
      elementSelector -
      actionClassStr -
      Throws:
      ClassNotFoundException
    • addRule

      void addRule(ElementSelector elementSelector, Supplier<Action> actionSupplier)
      Add a new rule, given by a pattern and an action instance.
      Parameters:
      elementSelector -
      action -
    • matchActions

      Supplier<Action> matchActions(ElementPath elementPath)
      Return a list of actions matching a pattern.
      Parameters:
      elementPath - the path to match for
      Returns:
      list of matching actions
    • addTransparentPathPart

      void addTransparentPathPart(String pathPart)