com.epimorphics.lda.support

Class Glob

java.lang.Object

com.epimorphics.lda.support.Glob

public class Glob
extends Object

Glob allows glob-like wildcard expansion in pathnames, specifically the use of * to represent any sequence of non-/ characters. A Glob is initialised with a FileSystemInterface instance that encapsulates the test for isDirectory() and listing files in a given directory; typically this just falls back to the usual File primitives.

note Future versions of this class may implement more globbing features.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Glob.FileSystemInterface A FileSystemInterface provides an interface onto a file system that allows querying for a name being a directory name and extracting from a directory a list of names that match a given pattern.

Field Summary

Fields

Modifier and Type	Field and Description
protected Glob.FileSystemInterface	fs The FileSystemInterface for querying the filesystem.

Constructor Summary

Constructors

Constructor and Description
Glob() Initialise this Glob with the default FileSystemInterface.
Glob(Glob.FileSystemInterface fs) Initialise this Glob with the specified FileSystemInterface.

Method Summary

Methods

Modifier and Type	Method and Description
String	extract(String glob, String name) Return the portion(s) of name that is matched by the wildcard(s) in glob, or null if there is no match.
String	extract(String glob, String join, String name)
List<File>	filesMatching(List<File> files, String path) filesMatching(files,path) appends to the files list all the files whose names match the provided path (as above) and returns that same list.
List<File>	filesMatching(String path) filesMatching(path) returns a list of all the files whose names match the provided path.
static boolean	isPathSeparator(char ch)
List<String>	splitFilePath(File f) Split a file into components such that the components are differences in reverse order of repeated getParentFile() calls, with file separators stripped if present.

Methods inherited from class java.lang.Object

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

Field Detail

fs

protected final Glob.FileSystemInterface fs

The FileSystemInterface for querying the filesystem.

Constructor Detail

Glob

public Glob()

Initialise this Glob with the default FileSystemInterface.

Glob

public Glob(Glob.FileSystemInterface fs)

Initialise this Glob with the specified FileSystemInterface.

Method Detail

filesMatching

public List<File> filesMatching(String path)

filesMatching(path) returns a list of all the files whose names match the provided path. "Matching" means that there are replacement strings (not containing /) for each of the '*'s in the path that make the path equal to the filename.

filesMatching

public List<File> filesMatching(List<File> files,
                       String path)

filesMatching(files,path) appends to the files list all the files whose names match the provided path (as above) and returns that same list.

extract

public String extract(String glob,
             String name)

Return the portion(s) of name that is matched by the wildcard(s) in glob, or null if there is no match.

extract

public String extract(String glob,
             String join,
             String name)

isPathSeparator

public static boolean isPathSeparator(char ch)

splitFilePath

public List<String> splitFilePath(File f)

Split a file into components such that the components are differences in reverse order of repeated getParentFile() calls, with file separators stripped if present.