org.apache.sshd.common.util

Class SelectorUtils

java.lang.Object

org.apache.sshd.common.util.SelectorUtils

public final class SelectorUtils
extends Object

This is a utility class used by selectors and DirectoryScanner. The functionality more properly belongs just to selectors, but unfortunately DirectoryScanner exposed these as protected methods. Thus we have to support any subclasses of DirectoryScanner that may access these methods.

This is a Singleton.

Since:

1.5

Version:

$Id$

Author:

Arnout J. Kuiper ajkuiper@wxs.nl, Magesh Umasankar, Bruce Atherton

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANT_HANDLER_PREFIX
static String	PATTERN_HANDLER_PREFIX
static String	PATTERN_HANDLER_SUFFIX
static String	REGEX_HANDLER_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isOutOfDate(File src, File target, int granularity) Returns dependency information on these two files.
static boolean	match(String pattern, String str) Tests whether or not a string matches against a pattern.
static boolean	match(String pattern, String str, boolean isCaseSensitive) Tests whether or not a string matches against a pattern.
static boolean	matchPath(String pattern, String str) Tests whether or not a given path matches a given pattern.
static boolean	matchPath(String pattern, String str, boolean isCaseSensitive) Tests whether or not a given path matches a given pattern.
static boolean	matchPatternStart(String pattern, String str) Tests whether or not a given path matches the start of a given pattern up to the first "**".
static boolean	matchPatternStart(String pattern, String str, boolean isCaseSensitive) Tests whether or not a given path matches the start of a given pattern up to the first "**".
static String	normalizePath(String path, String separator) Normalizes the path by removing '.', '..' and double separators (e.g.
static String	removeWhitespace(String input) "Flattens" a string by removing all whitespace (space, tab, linefeed, carriage return, and formfeed).
static List<String>	tokenizePath(String path) Breaks a path up into a Vector of path elements, tokenizing on File.separator.
static List<String>	tokenizePath(String path, String separator)

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_HANDLER_PREFIX

public static final String PATTERN_HANDLER_PREFIX

See Also:

Constant Field Values

PATTERN_HANDLER_SUFFIX

public static final String PATTERN_HANDLER_SUFFIX

See Also:

Constant Field Values

REGEX_HANDLER_PREFIX

public static final String REGEX_HANDLER_PREFIX

See Also:

Constant Field Values

ANT_HANDLER_PREFIX

public static final String ANT_HANDLER_PREFIX

See Also:

Constant Field Values

Method Detail

matchPatternStart

public static boolean matchPatternStart(String pattern,
                        String str)

Tests whether or not a given path matches the start of a given pattern up to the first "**".

This is not a general purpose test and should only be used if you can live with false positives. For example, pattern=**\a and str=b will yield true.

Parameters:

pattern - The pattern to match against. Must not be null.

str - The path to match, as a String. Must not be null.

Returns:

whether or not a given path matches the start of a given pattern up to the first "**".

matchPatternStart

public static boolean matchPatternStart(String pattern,
                        String str,
                        boolean isCaseSensitive)

Tests whether or not a given path matches the start of a given pattern up to the first "**".

This is not a general purpose test and should only be used if you can live with false positives. For example, pattern=**\a and str=b will yield true.

Parameters:

pattern - The pattern to match against. Must not be null.

str - The path to match, as a String. Must not be null.

isCaseSensitive - Whether or not matching should be performed case sensitively.

Returns:

whether or not a given path matches the start of a given pattern up to the first "**".

matchPath

public static boolean matchPath(String pattern,
                String str)

Tests whether or not a given path matches a given pattern.

Parameters:

pattern - The pattern to match against. Must not be null.

str - The path to match, as a String. Must not be null.

Returns:

true if the pattern matches against the string, or false otherwise.

matchPath

public static boolean matchPath(String pattern,
                String str,
                boolean isCaseSensitive)

Tests whether or not a given path matches a given pattern.

Parameters:

pattern - The pattern to match against. Must not be null.

str - The path to match, as a String. Must not be null.

isCaseSensitive - Whether or not matching should be performed case sensitively.

Returns:

true if the pattern matches against the string, or false otherwise.

match

public static boolean match(String pattern,
            String str)

Tests whether or not a string matches against a pattern. The pattern may contain two special characters:
'*' means zero or more characters
'?' means one and only one character

Parameters:

pattern - The pattern to match against. Must not be null.

str - The string which must be matched against the pattern. Must not be null.

Returns:

true if the string matches against the pattern, or false otherwise.

match

public static boolean match(String pattern,
            String str,
            boolean isCaseSensitive)

Tests whether or not a string matches against a pattern. The pattern may contain two special characters:
'*' means zero or more characters
'?' means one and only one character

Parameters:

pattern - The pattern to match against. Must not be null.

str - The string which must be matched against the pattern. Must not be null.

isCaseSensitive - Whether or not matching should be performed case sensitively.

Returns:

true if the string matches against the pattern, or false otherwise.

tokenizePath

public static List<String> tokenizePath(String path)

Breaks a path up into a Vector of path elements, tokenizing on File.separator.

Parameters:

path - Path to tokenize. Must not be null.

Returns:

a List of path elements from the tokenized path

tokenizePath

public static List<String> tokenizePath(String path,
                        String separator)

normalizePath

public static String normalizePath(String path,
                   String separator)
                            throws IOException

Normalizes the path by removing '.', '..' and double separators (e.g. '//')

Parameters:

path -

separator -

Returns:

normalized path

Throws:

IOException - when the path is invalid (e.g. '/first/../..')

isOutOfDate

public static boolean isOutOfDate(File src,
                  File target,
                  int granularity)

Returns dependency information on these two files. If src has been modified later than target, it returns true. If target doesn't exist, it likewise returns true. Otherwise, target is newer than src and is not out of date, thus the method returns false. It also returns false if the src file doesn't even exist, since how could the target then be out of date.

Parameters:

src - the original file

target - the file being compared against

granularity - the amount in seconds of slack we will give in determining out of dateness

Returns:

whether the target is out of date

removeWhitespace

public static String removeWhitespace(String input)

"Flattens" a string by removing all whitespace (space, tab, linefeed, carriage return, and formfeed). This uses StringTokenizer and the default set of tokens as documented in the single arguement constructor.

Parameters:

input - a String to remove all whitespace.

Returns:

a String that has had all whitespace removed.