org.bridje.vfs

Class GlobExpr

java.lang.Object

org.bridje.vfs.GlobExpr

public class GlobExpr
extends Object

A glob syntax expression for file search.

Constructor Summary

Constructors

Constructor and Description
GlobExpr(String glob) Default constructor for the GlobExpr object.

Method Summary

Modifier and Type	Method and Description
String	getValue() The glob syntax expression.
boolean	globMatches(Path path) Tests the path against a string path with glob syntax.
Path	globRemaining(Path path) Obtains the path remaining of matches a path with glob syntax.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobExpr

public GlobExpr(String glob)

Default constructor for the GlobExpr object.

Parameters:

glob - THe glob syntax expression for this object.

Method Detail

getValue

public String getValue()

The glob syntax expression.

Returns:

The glob syntax expression.

toString

public String toString()

Overrides:

toString in class Object

globMatches

public boolean globMatches(Path path)

Tests the path against a string path with glob syntax.

Glob syntax follows the following simple rules:

• Asterisk "*": matches any number of characters (including none).
• Two asterisks "**": is like "*" but includes directory separator. Is generally used for matching complete paths.
• Question mark "?": matches exactly one character.
• Braces specify a collection of sub patterns. For example:
  - "{java,maven,bridje}" matches "java", "maven", or "bridje".
  - "{gradle*,ant*}" matches all strings beginning with "gradle" or "ant".
• Square brackets defines a set of single characters or, when used with the hyphen character "-", a range of characters. For example:
  - "[aeiou]" matches any lowercase vowel.
  - "[0-9]" matches any digit.
  - "[A-Z]" matches any uppercase letter.
  - "[a-z,A-Z]" matches any uppercase or lowercase letter.
  Within the square brackets, "*", "?", and "\" match themselves.
• All other characters match themselves.

To match "*", "?", or the other special characters, you can escape them by using the backslash character, "\". For example: "\\" matches a single backslash, and "\?" matches the question mark.

Parameters:

path - path to test

Returns:

true if the glob match this path, false otherwise.

globRemaining

public Path globRemaining(Path path)

Obtains the path remaining of matches a path with glob syntax.

Parameters:

path - path to search

Returns:

if the glob match this path beginning will return the remaining path, this full path otherwise.

See Also:

globMatches(Path)