com.day.cq.wcm.commons

Class GlobPattern

java.lang.Object

com.day.cq.wcm.commons.GlobPattern

public class GlobPattern
extends java.lang.Object

The GlobPattern implements matching operations that do a pattern globbing.
This class is copied from day-commons-text and should not be used anymore. switch to regexp patterns if possible.

Constructor Summary

Constructors

Constructor and Description
GlobPattern(java.lang.String pattern) Class constructor that create a GlobPattern with the given pattern.
GlobPattern(java.lang.String pattern, boolean isHandle) Class constructor that create a GlobPattern with the given pattern.

Method Summary

Modifier and Type	Method and Description
static boolean	containsWildcards(java.lang.String s) Returns true if the string contains wildcards.
boolean	equals(java.lang.Object obj) Returns true if this GlobPattern is equal to object obj.
int	hashCode() Returns the hashCode for this GlobPattern.
static int	indexOfWildcard(java.lang.String s) Returns the index of the first wildcard character in the string or -1 if the string does not contain a wild card character.
boolean	matches(java.lang.String s) Returns a flag indicating whether a string matches this pattern.
static boolean	matches(java.lang.String pattern, java.lang.String s) Returns a flag indicating whether a string matches a pattern.
static boolean	matches(java.lang.String pattern, java.lang.String s, boolean isHandle) Returns a flag indicating whether a string matches a pattern.
boolean	shellMatches(java.lang.String s) Returns a flag indicating whether a string matches a pattern.
boolean	shellMatches(java.lang.String s, char c) Returns a flag indicating whether a string matches a pattern.
java.lang.String	toString() Returns the pattern of this GlobPattern

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobPattern

public GlobPattern(java.lang.String pattern,
                   boolean isHandle)

Class constructor that create a GlobPattern with the given pattern. If the isHandle flag is true this will construct a hierarchy matcher.

Parameters:

pattern - pattern string

isHandle - if true and the pattern contains no wildcards, the matches(String) returns true, if the compared string is equal or starts with the pattern+"/" (i.e. is a child page)

GlobPattern

public GlobPattern(java.lang.String pattern)

Class constructor that create a GlobPattern with the given pattern.

Parameters:

pattern - pattern string

Method Detail

matches

public final boolean matches(java.lang.String s)

Returns a flag indicating whether a string matches this pattern.

Parameters:

s - string to be checked

Returns:

true if s matches this pattern, else false.

matches

public static boolean matches(java.lang.String pattern,
                              java.lang.String s)

Returns a flag indicating whether a string matches a pattern.

Parameters:

pattern - pattern used for comparison

s - string to be checked

Returns:

true if s matches pattern, else false.

matches

public static boolean matches(java.lang.String pattern,
                              java.lang.String s,
                              boolean isHandle)

Returns a flag indicating whether a string matches a pattern. if the ishHandle is true and the pattern contains no wildcards, the method returns true, if the pattern is a hierarchical father of the string.

Parameters:

pattern - pattern used for comparison

s - string to be checked

isHandle - flag, indicating, if a handle comparison has to be performed

Returns:

true if s matches pattern, else false.

shellMatches

public boolean shellMatches(java.lang.String s)

Returns a flag indicating whether a string matches a pattern. unlike the matches methods, this matching is done shell-like.

Parameters:

s - string to be checked

Returns:

true if the string matches shell-like; false otherwise.

shellMatches

public boolean shellMatches(java.lang.String s,
                            char c)

Returns a flag indicating whether a string matches a pattern. unlike the matches methods, this matching is done shell-like.

Parameters:

s - string to be checked

c - character to be used as path delimiter

Returns:

true if the string matches shell-like; false otherwise.

containsWildcards

public static boolean containsWildcards(java.lang.String s)

Returns true if the string contains wildcards.

Parameters:

s - string to be checked

Returns:

true if s contains wildcards, else false.

indexOfWildcard

public static int indexOfWildcard(java.lang.String s)

Returns the index of the first wildcard character in the string or -1 if the string does not contain a wild card character.

Parameters:

s - string to be checked

Returns:

the index of the first wildcard.

toString

public java.lang.String toString()

Returns the pattern of this GlobPattern

Overrides:

toString in class java.lang.Object

Returns:

the pattern.

equals

public boolean equals(java.lang.Object obj)

Returns true if this GlobPattern is equal to object obj.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare for equality.

Returns:

true if this GlobPattern is equal to object obj.

hashCode

public int hashCode()

Returns the hashCode for this GlobPattern.

Overrides:

hashCode in class java.lang.Object

Returns:

the hashCode for this GlobPattern.