Module org.eclipse.jgit

Package org.eclipse.jgit.ignore.internal

Class PathMatcher

java.lang.Object

org.eclipse.jgit.ignore.internal.AbstractMatcher

org.eclipse.jgit.ignore.internal.PathMatcher

All Implemented Interfaces:

IMatcher

public class PathMatcher
extends AbstractMatcher

Matcher built by patterns consists of multiple path segments.

This class is immutable and thread safe.

Field Summary

Fields inherited from interface org.eclipse.jgit.ignore.IMatcher

NO_MATCH

Method Summary

Modifier and Type	Method	Description
static IMatcher	createPathMatcher(String pattern, Character pathSeparator, boolean dirOnly)	Create path matcher
boolean	matches(String path, boolean assumeDirectory, boolean pathMatch)	Matches entire given string
boolean	matches(String segment, int startIncl, int endExcl)	Matches only part of given string

Methods inherited from class org.eclipse.jgit.ignore.internal.AbstractMatcher

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createPathMatcher

public static IMatcher createPathMatcher(String pattern,
                                         Character pathSeparator,
                                         boolean dirOnly)
                                  throws InvalidPatternException

Create path matcher

Parameters:

pattern - a pattern

pathSeparator - if this parameter isn't null then this character will not match at wildcards(* and ? are wildcards).

dirOnly - a boolean.

Returns:

never null

Throws:

InvalidPatternException

matches

public boolean matches(String path,
                       boolean assumeDirectory,
                       boolean pathMatch)

Matches entire given string

Parameters:

path - string which is not null, but might be empty

assumeDirectory - true to assume this path as directory (even if it doesn't end with a slash)

pathMatch - true if the match is for the full path: prefix-only matches are not allowed

Returns:

true if this matcher pattern matches given string

matches

public boolean matches(String segment,
                       int startIncl,
                       int endExcl)

Matches only part of given string

Parameters:

segment - string which is not null, but might be empty

startIncl - start index, inclusive

endExcl - end index, exclusive

Returns:

true if this matcher pattern matches given string