com.aoindustries.util

Class WildcardPatternMatcher

java.lang.Object

com.aoindustries.util.WildcardPatternMatcher

public abstract class WildcardPatternMatcher
extends Object

Matches simple wildcard patterns. A wildcard pattern is any combination of '*' and textual values. For example, some patterns would include:

• "" Match none
• "*" Match all
• "prefix*" Prefix match
• "*suffix" Suffix match
• "prefix*suffix" Prefix and suffix match
• "*infix*" Infix match
• "prefix*infix*" Prefix and infix match
• "*infix*suffix" Infix and suffix match
• "prefix*infix*suffix" Prefix, infix, and suffix match
• "exact_value" Exact match

Any consecutive sequence of '*' are combined into a single '*'.

All matchers are thread-safe.

WildcardPatternMatcher are measured typically 2 to 100 times as fast as Pattern, and have been measured up to 2000 times as fast in contrived scenarios (suffix match on long strings), and should never be slower in their limited use-case domain.

TODO: Support "**" as an escape for literal '*' in matching? No longer collapse adjacent '*'?

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method and Description
static WildcardPatternMatcher	compile(String patterns) Gets the matcher for the comma and/or space separated patterns.
static WildcardPatternMatcher	getInstance(String patterns) Deprecated. Please use compile(java.lang.String) instead.
static WildcardPatternMatcher	getMatchAll() Deprecated. Please use matchAll() instead.
static WildcardPatternMatcher	getMatchNone() Deprecated. Please use matchNone() instead.
boolean	isEmpty() Checks if this is empty (has no patterns).
abstract boolean	isMatch(String paramName)
static WildcardPatternMatcher	matchAll() Gets the match all matcher.
static WildcardPatternMatcher	matchNone() Gets the match none matcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

matchNone

public static WildcardPatternMatcher matchNone()

Gets the match none matcher.

getMatchNone

@Deprecated
public static WildcardPatternMatcher getMatchNone()

Deprecated. Please use matchNone() instead.

matchAll

public static WildcardPatternMatcher matchAll()

Gets the match all matcher.

getMatchAll

@Deprecated
public static WildcardPatternMatcher getMatchAll()

Deprecated. Please use matchAll() instead.

compile

public static WildcardPatternMatcher compile(String patterns)

Gets the matcher for the comma and/or space separated patterns.

Any null or empty pattern matches none.

getInstance

@Deprecated
public static WildcardPatternMatcher getInstance(String patterns)

Deprecated. Please use compile(java.lang.String) instead.

isEmpty

public boolean isEmpty()

Checks if this is empty (has no patterns). Any empty matcher does not match anything.

isMatch

public abstract boolean isMatch(String paramName)