Package org.eclipse.sisu.space

Enum GlobberStrategy

java.lang.Object

java.lang.Enum<GlobberStrategy>

org.eclipse.sisu.space.GlobberStrategy

All Implemented Interfaces:

Serializable, Comparable<GlobberStrategy>

public enum GlobberStrategy
extends Enum<GlobberStrategy>

Enumerates various optimized globbing strategies.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANYTHING
EXACT
PATTERN
PREFIX
SUFFIX

Method Summary

Modifier and Type	Method	Description
boolean	basenameMatches(String globPattern, String path)	Attempts to match the given compiled glob pattern against the basename of a path.
String	compile(String glob)	Compiles the given plain-text glob into an optimized pattern.
abstract boolean	matches(String globPattern, String name)	Attempts to match the given compiled glob pattern against a name.
static GlobberStrategy	selectFor(String glob)	Selects the optimal globber strategy for the given plain-text glob.
static GlobberStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GlobberStrategy[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANYTHING

public static final GlobberStrategy ANYTHING

SUFFIX

public static final GlobberStrategy SUFFIX

PREFIX

public static final GlobberStrategy PREFIX

EXACT

public static final GlobberStrategy EXACT

PATTERN

public static final GlobberStrategy PATTERN

Method Detail

values

public static GlobberStrategy[] 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 (GlobberStrategy c : GlobberStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static GlobberStrategy 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

selectFor

public static final GlobberStrategy selectFor(String glob)

Selects the optimal globber strategy for the given plain-text glob.

Parameters:

glob - The plain-text glob

Returns:

Optimal globber strategy

compile

public String compile(String glob)

Compiles the given plain-text glob into an optimized pattern.

Parameters:

glob - The plain-text glob

Returns:

Compiled glob pattern

matches

public abstract boolean matches(String globPattern,
                                String name)

Attempts to match the given compiled glob pattern against a name.

Parameters:

globPattern - The compiled glob pattern

name - The candidate name

Returns:

true if the pattern matches; otherwise false

basenameMatches

public final boolean basenameMatches(String globPattern,
                                     String path)

Attempts to match the given compiled glob pattern against the basename of a path.

Parameters:

globPattern - The compiled glob pattern

path - The candidate path

Returns:

true if the pattern matches; otherwise false