de.unkrig.ref4j

Class PatternFactory

java.lang.Object

de.unkrig.ref4j.PatternFactory

Direct Known Subclasses:

PatternFactory

public abstract class PatternFactory
extends Object

A facade or abstraction for various regular expression frameworks.

To get

  ServiceLoader<PatternFactory> patternFactory = ServiceLoader.load(PatternFactory.class);
 

Constructor Summary

Constructors

Constructor and Description
PatternFactory()

Method Summary

Modifier and Type	Method and Description
Pattern	compile(String regex) Compiles the given regex into a Pattern.
abstract Pattern	compile(String regex, int flags) Compiles the given regex into a Pattern with the given flags.
static PatternFactory	get() Returns the pattern factory configured in this JVM.
static PatternFactory	get(String fullyQualifiedClassName)
abstract String	getId()
abstract int	getSupportedFlags()
abstract boolean	matches(String regex, CharSequence input)
String	quote(String s)
String	quoteReplacement(String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternFactory

public PatternFactory()

Method Detail

get

public static PatternFactory get()

Returns the pattern factory configured in this JVM.

• The class named by the system property "de.unkrig.ref4j.PatternFactory" (if the system property is set and the class is registered as a pattern factory)
• The first of all registered pattern factories on the classpath (if any)
• The java.util.regex pattern factory

See Also:

EnhancedServiceLoader.load(Class)

getId

public abstract String getId()

Returns:

A package name-like string that is unique among all existing pattern factory implementations

get

@Nullable
public static PatternFactory get(String fullyQualifiedClassName)

Returns:

The class that has the given name and extends the PatternFactory class

getSupportedFlags

public abstract int getSupportedFlags()

Returns:

The union of all flags supported by this engine.

compile

public Pattern compile(String regex)
                throws PatternSyntaxException

Compiles the given regex into a Pattern.

Throws:

PatternSyntaxException

compile

public abstract Pattern compile(String regex,
                                int flags)
                         throws PatternSyntaxException

Compiles the given regex into a Pattern with the given flags.

Parameters:

flags - The or'ed compilation flag constants declared by Pattern

Throws:

IllegalArgumentException - A flag was given that is not set in getSupportedFlags()

PatternSyntaxException

See Also:

Pattern.compile(String, int), Pattern.compile(String), Pattern.CANON_EQ, Pattern.CASE_INSENSITIVE, Pattern.COMMENTS, Pattern.DOTALL, Pattern.LITERAL, Pattern.MULTILINE, Pattern.UNICODE_CASE, Pattern.UNICODE_CHARACTER_CLASS, Pattern.UNIX_LINES

matches

public abstract boolean matches(String regex,
                                CharSequence input)

See Also:

Pattern.matches(String, CharSequence)

quote

public String quote(String s)

See Also:

Pattern.quote(String)

quoteReplacement

public String quoteReplacement(String s)

See Also:

Matcher.quoteReplacement(String)