com.helger.commons.regex

Class RegExPattern

java.lang.Object

com.helger.commons.regex.RegExPattern

All Implemented Interfaces:

Serializable

@ThreadSafe
 @DevelopersNote(value="The mutable m_aHashCode does not contradict thread safety")
public final class RegExPattern
extends Object
implements Serializable

This class encapsulates a String and a set of options to be used in Pattern compilation

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegExPattern(String sRegEx)
RegExPattern(String sRegEx, int nOptions)

Method Summary

Modifier and Type	Method and Description
static boolean	areDebugConsistencyChecksEnabled()
static void	checkPatternConsistency(String sRegEx)
static void	enableDebugConsistencyChecks(boolean bEnable)
boolean	equals(Object o)
Pattern	getAsPattern()
int	getOptions()
String	getRegEx()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegExPattern

public RegExPattern(@Nonnull @Nonempty @RegEx
                    String sRegEx)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

RegExPattern

public RegExPattern(@Nonnull @Nonempty @RegEx
                    String sRegEx,
                    @Nonnegative
                    int nOptions)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

areDebugConsistencyChecksEnabled

public static boolean areDebugConsistencyChecksEnabled()

enableDebugConsistencyChecks

public static void enableDebugConsistencyChecks(boolean bEnable)

checkPatternConsistency

public static void checkPatternConsistency(@Nonnull @RegEx
                                           String sRegEx)
                                    throws IllegalArgumentException

Throws:

IllegalArgumentException

getRegEx

@Nonnull
 @Nonempty
 @RegEx
public String getRegEx()

Returns:

The source regular expression string. Neither null nor empty.

getOptions

@Nonnegative
public int getOptions()

Returns:

The RegEx options provided in the constructor. 0 means no options.

getAsPattern

@Nonnull
public Pattern getAsPattern()

Returns:

The precompiled pattern. Never null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object