Module org.refcodes.matcher
Package org.refcodes.matcher

Class RegExpMatcher

java.lang.Object
org.refcodes.matcher.AbstractMatcher<M>
org.refcodes.matcher.AbstractWildcardMatcher<String>
org.refcodes.matcher.RegExpMatcher
All Implemented Interfaces:
Matchable<String>, Matcher<String>, WildcardMatcher, org.refcodes.mixin.PatternAccessor, org.refcodes.mixin.Schemable<MatcherSchema>
public class RegExpMatcher extends AbstractWildcardMatcher<String> implements WildcardMatcher, org.refcodes.mixin.PatternAccessor
The REGEXP RegExpMatcher provides WildcardMatcher functionality for regular expression Pattern matching.

  • Constructor Details

  • Method Details

    • getWildcardNames

      public String[] getWildcardNames()
      Retrieves the list of wildcard names identifying the wildcards as specified by the pattern.
      Specified by:
      getWildcardNames in interface WildcardMatcher
      Returns:
      The wild card names or null of no wild card names have been defined.

    • getPattern

      public Pattern getPattern()
      Specified by:
      getPattern in interface org.refcodes.mixin.PatternAccessor

    • isMatching

      public boolean isMatching(String aText)
      Tests whether the given event is matching the mathcer's criteria.
      Specified by:
      isMatching in interface Matchable<String>
      Parameters:
      aText - The matchee used for testing matchability.
      Returns:
      True in case the matchee matches the matcher's criteria, else false.

    • toWildcardSubstitutes

      public org.refcodes.mixin.WildcardSubstitutes toWildcardSubstitutes(String aText)
      Returns all available wildcard substitutes as well as the named wildcard substitutes.
      Specified by:
      toWildcardSubstitutes in interface WildcardMatcher
      Parameters:
      aText - Tex textfor which to retrieve the wildcard substitutes.
      Returns:
      The WildcardSubstitutes of the wildcards being substituted.

    • toWildcardReplacements

      public String[] toWildcardReplacements(String aText)
      Returns an array of the wildcard substitutes for the wildcards in your pattern compared to the actual text (as of WildcardMatcher.toWildcardSubstitutes(String)). The order of the wildcard substitutes aligns to the order of the wildcards (from left to right) defined in your pattern.
      Specified by:
      toWildcardReplacements in interface WildcardMatcher
      Parameters:
      aText - Tex textfor which to retrieve the wildcard substitutes.
      Returns:
      The text substituting the wildcards in the order of the wildcards being substituted or null if there are none such substitutes.

    • toWildcardReplacementAt

      public String toWildcardReplacementAt(String aText, int aIndex)
      Returns the wildcard substitute for the wildcards in your pattern compared to the actual text (as of WildcardMatcher.toWildcardSubstitutes(String)). The text of the wildcard substitute aligns to the index of the wildcard (from left to right) as defined in your pattern.
      Specified by:
      toWildcardReplacementAt in interface WildcardMatcher
      Parameters:
      aText - Tex textfor which to retrieve the wildcard substitutes.
      aIndex - The index of the wildcard in question for which to retrieve the substitute.
      Returns:
      The text substituting the wildcard at the given pattern's wildcard index or null if there is none such substitute.

    • toWildcardReplacementsAt

      public String[] toWildcardReplacementsAt(String aText, int... aIndexes)
      Returns the wildcard substitutes for the wildcards in your pattern compared to the actual text. The text of the wildcard substitutes aligns to the indexes of the wildcard (from left to right) as defined in your pattern.
      Specified by:
      toWildcardReplacementsAt in interface WildcardMatcher
      Parameters:
      aText - Tex textfor which to retrieve the wildcard substitutes.
      aIndexes - The indexes of the wildcards in question for which to retrieve the substitutes.
      Returns:
      The text substituting the wildcards at the given pattern's wildcard indexes or null if there is none such substitute.

    • toWildcardReplacement

      public String toWildcardReplacement(String aText, String aWildcardName)
      Returns the wildcard substitute for the wildcards in your pattern compared to the actual text. The text of the wildcard substitute aligns to the name of the wildcard (as defined in your pattern).
      Specified by:
      toWildcardReplacement in interface WildcardMatcher
      Parameters:
      aText - Tex textfor which to retrieve the wildcard substitutes.
      aWildcardName - The name of the wildcard in question for which to retrieve the substitute.
      Returns:
      The text substituting the wildcard with the given pattern's wildcard name or null if there is none such substitute.

    • toWildcardReplacements

      public String[] toWildcardReplacements(String aText, String... aWildcardNames)
      Returns the wildcard substitutes for the wildcards in your pattern compared to the actual text . The text of the wildcard substitutes aligns to the order of the provided wildcard names (as defined in your pattern).
      Specified by:
      toWildcardReplacements in interface WildcardMatcher
      Parameters:
      aText - Tex textfor which to retrieve the wildcard substitutes.
      aWildcardNames - The names of the wildcards in question for which to retrieve the substitutes in the order of the provided names.
      Returns:
      The text substituting the wildcard with the given pattern's wildcard names or null if there are none such substitute.

    • toPattern

      public String toPattern()
      For debugging purposes, retrieve the regex pattern created from the ANT path pattern.
      Returns:
      Returns the regex created from the ANT path pattern.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toSchema

      public MatcherSchema toSchema()
      Specified by:
      toSchema in interface org.refcodes.mixin.Schemable<MatcherSchema>
      Overrides:
      toSchema in class AbstractMatcher<String>