Module org.refcodes.matcher

Package org.refcodes.matcher

package org.refcodes.matcher

This artifact allows the construction of matchers for building arbitrary complex matching functionality. It is used to test whether matchee instances match certain criteria. Matcher instances may get nested in a hierarchy (using e.g. the OrMatcher, the AndMatcher or the NotMatcher types), having different matchers in combination will do custom matching. Some examples for Matcher implementations are the EqualWithMatcher, the PathMatcher,the LessThanMatcher or the RegExpMatcher. Use the MatcherSugar syntactic sugar mixin for expressively building your matchers.

Please refer to the refcodes-matcher: Build custom matching logic and match path patterns documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
AbstractMatcheeMatcher<M>	The AbstractMatcheeMatcher is composed of multiple Matcher instances queried upon match requests as of Matchable.isMatching(Object).
AbstractMatcher<M>	The AbstractMatcher provides a base functionality for Matcher implementations.
AbstractMatcherComposite<M>	The AbstractMatcherComposite is composed of multiple Matcher instances queried upon match requests as of Matchable.isMatching(Object).
AbstractWildcardMatcher<M>	The AbstractWildcardMatcher provides a base functionality for Matcher implementations.
AbstractWildcardMatcher.WildcardMatcherSubstitutes	The Class WildcardMatcherSubstitutes.
AndMatcher<M>	A logical AND implementation of a Matcher encapsulating Matcher instances.
AnyMatcher<M>	An ANY implementation of a Matcher which always returns true.
EqualWithMatcher<M>	An EQUAL WITH Matcher, comparing its matchee with the matchee provided to the EqualWithMatcher.isMatching(Object) method for equality.
GreaterOrEqualThanMatcher<M extends Comparable<M>>	A GREATER OR EQUAL THAN Matcher, comparing its matchee with the matchee provided to the Matchable.isMatching(Object) method using the Comparable.compareTo(Object) method to be implemented by the matchees.
GreaterThanMatcher<M extends Comparable<M>>	A GREATER THAN Matcher, comparing its matchee with the matchee provided to the Matchable.isMatching(Object) method using the Comparable.compareTo(Object) method to be implemented by the matchees.
IsAssignableFromMatcher<M>	A IS ASSIGNABLE FROM implementation of a Matcher by type.
LessOrEqualThanMatcher<M extends Comparable<M>>	A LESS OR EQUAL THAN Matcher, comparing its matchee with the matchee provided to the Matchable.isMatching(Object) method using the Comparable.compareTo(Object) method to be implemented by the matchees.
LessThanMatcher<M extends Comparable<M>>	A LESS THAN Matcher, comparing its matchee with the matchee provided to the Matchable.isMatching(Object) method using the Comparable.compareTo(Object) method to be implemented by the matchees.
Matchable<M>	The Matchable interface is intended for components providing matching functionality though not being a Matcher.
Matcher<M>	The matcher is used to test whether a matchee matches certain criteria.
MatcherSchema	The purpose of a MatcherSchema is automatically generate documentation of Matcher structures.
MatcherSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the Matcher elements.
NoneMatcher<M>	A NONE implementation of a Matcher which always returns false.
NotEqualWithMatcher<M>	A NOT EQUAL WITH Matcher, comparing its matchee with the matchee provided to the NotEqualWithMatcher.isMatching(Object) method for equality.
NotMatcher<M>	A logical NOT implementation of a Matcher encapsulating another Matcher.
OrMatcher<M>	A logical OR implementation of a Matcher encapsulating Matcher instances.
PathMatcher	The PathMatcher provides WildcardMatcher functionality for matching paths: The PathMatcher matches its ANT like path pattern against the path provided to the PathMatcher.isMatching(String) and the like methods.
RegExpMatcher	The REGEXP RegExpMatcher provides WildcardMatcher functionality for regular expression Pattern matching.
WildcardMatcher	A WildcardMatcher is a Matcher providing additional means to work with the wildcards and their wildcard substitutes in case of a match as of Matchable.isMatching(Object).