org.apache.oro.text.regex
Interface PatternCompilerOptions

All Known Implementing Classes:

AwkCompilerOptions, GlobCompilerOptions, JavaCompilerOptions, Perl5CompilerOptions

public interface PatternCompilerOptions

PatternCompilerOptions abstracts the options used by regular expression engines into a common set. These options are represented as integer constants that must be mapped to a value native to the regular expression implementation.

Since:

2.1

Version:

2.1-dev-1

Field Summary

static int	CASE_INSENSITIVE An option indicating a compiled regular expression should be case insensitive.
static int	DEFAULT The default set of options used by a PatternCompiler.
static int	MULTILINE An option indicating a compiled regular expression should treat input as having multiple lines.

Method Summary

int	getMask(int option) Maps one of the PatternCompilerOptions constants to a mask value that can be passed to a PatternCompiler implementation to compile a pattern.

Field Detail

DEFAULT

public static final int DEFAULT

The default set of options used by a PatternCompiler.

See Also:

Constant Field Values

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE

An option indicating a compiled regular expression should be case insensitive.

See Also:

Constant Field Values

MULTILINE

public static final int MULTILINE

An option indicating a compiled regular expression should treat input as having multiple lines.

See Also:

Constant Field Values

Method Detail

getMask

public int getMask(int option)
            throws java.lang.UnsupportedOperationException

Maps one of the PatternCompilerOptions constants to a mask value that can be passed to a PatternCompiler implementation to compile a pattern.

Parameters:

option - A PatternCompilerOptions option constant.

Returns:

The mask value specific to the regular expression engine that corresponds to the option parameter.

Throws:

java.lang.UnsupportedOperationException