uk.ac.starlink.topcat

Enum ColumnSearchWindow.SearchScope

java.lang.Object

java.lang.Enum<ColumnSearchWindow.SearchScope>

uk.ac.starlink.topcat.ColumnSearchWindow.SearchScope

All Implemented Interfaces:

Serializable, Comparable<ColumnSearchWindow.SearchScope>

Enclosing class:

ColumnSearchWindow

public static enum ColumnSearchWindow.SearchScope
extends Enum<ColumnSearchWindow.SearchScope>

Enum for search target scope.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINS Target string contains match text.
FULL Whole target string is matched by match text.

Method Summary

Modifier and Type	Method and Description
abstract boolean	matches(Matcher matcher) Indicates whether a regex matcher matches according to this scope.
String	toString()
static ColumnSearchWindow.SearchScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ColumnSearchWindow.SearchScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTAINS

public static final ColumnSearchWindow.SearchScope CONTAINS

Target string contains match text.

FULL

public static final ColumnSearchWindow.SearchScope FULL

Whole target string is matched by match text.

Method Detail

values

public static ColumnSearchWindow.SearchScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ColumnSearchWindow.SearchScope c : ColumnSearchWindow.SearchScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ColumnSearchWindow.SearchScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

matches

public abstract boolean matches(Matcher matcher)

Indicates whether a regex matcher matches according to this scope.

Parameters:

matcher - matcher

Returns:

true iff match is achieved

toString

public String toString()

Overrides:

toString in class Enum<ColumnSearchWindow.SearchScope>