程序包 org.microbean.helm.chart

类 HelmIgnorePathMatcher

java.lang.Object

org.microbean.helm.chart.HelmIgnorePathMatcher

所有已实现的接口:

PathMatcher, Predicate<Path>

public class HelmIgnorePathMatcher
extends Object
implements PathMatcher, Predicate<Path>

A PathMatcher and a Predicate<Path> that matches paths using the syntax of a .helmignore file.

This class passes all of the unit tests present in the Helm project's package concerned with .helmignore files. It may permit richer syntax, but there are no guarantees made regarding the behavior of this class in such cases.

Thread Safety

This class is safe for concurrent use by multiple threads.

作者:

Laird Nelson

另请参阅:

The Helm project's package concerned with .helmignore files

构造器概要

构造器

构造器	说明
HelmIgnorePathMatcher()	Creates a new HelmIgnorePathMatcher.
HelmIgnorePathMatcher(Reader reader)	Creates a new HelmIgnorePathMatcher.
HelmIgnorePathMatcher(Path helmIgnoreFile)	Creates a new HelmIgnorePathMatcher.
HelmIgnorePathMatcher(Collection<? extends String> stringPatterns)	Creates a new HelmIgnorePathMatcher.

方法概要

修饰符和类型	方法	说明
void	addPattern(String stringPattern)	Calls the addPatterns(Collection) method with a singleton Set consisting of the supplied stringPattern.
void	addPatterns(Collection<? extends String> stringPatterns)	Adds all of the valid .helmignore patterns present in the supplied Collection of such patterns.
boolean	matches(Path path)	Returns true if the supplied Path is neither null, the empty path ("") nor the "current directory" path ("." or "./"), and if at least one of the patterns added via the addPatterns(Collection) method logically matches it.
boolean	test(Path path)	Calls the matches(Path) method with the supplied Path and returns its results.

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.function.Predicate

and, negate, or

构造器详细资料

HelmIgnorePathMatcher

public HelmIgnorePathMatcher()

Creates a new HelmIgnorePathMatcher.

HelmIgnorePathMatcher

public HelmIgnorePathMatcher(Collection<? extends String> stringPatterns)

Creates a new HelmIgnorePathMatcher.

参数:

stringPatterns - a Collection of valid .helmignore patterns; may be null

抛出:

PatternSyntaxException - if any of the patterns is invalid

HelmIgnorePathMatcher

public HelmIgnorePathMatcher(Reader reader)
                      throws IOException

Creates a new HelmIgnorePathMatcher.

参数:

reader - a Reader expected to provide access to a logical collection of lines of text, each line of which is a valid .helmignore pattern (or blank line, or comment); may be null; never closed

抛出:

IOException - if an error related to the supplied reader is encountered

PatternSyntaxException - if any of the patterns is invalid

HelmIgnorePathMatcher

public HelmIgnorePathMatcher(Path helmIgnoreFile)
                      throws IOException

Creates a new HelmIgnorePathMatcher.

参数:

helmIgnoreFile - a Path expected to provide access to a logical collection of lines of text, each line of which is a valid .helmignore pattern (or blank line, or comment); may be null; never closed

抛出:

IOException - if an error related to the supplied helmIgnoreFile is encountered

PatternSyntaxException - if any of the patterns is invalid

另请参阅:

HelmIgnorePathMatcher(Reader)

方法详细资料

addPattern

public final void addPattern(String stringPattern)

Calls the addPatterns(Collection) method with a singleton Set consisting of the supplied stringPattern.

参数:

stringPattern - a valid .helmignore pattern; may be null or empty or prefixed with a # character, in which case no action will be taken

另请参阅:

addPatterns(Collection), matches(Path)

addPatterns

public void addPatterns(Collection<? extends String> stringPatterns)

Adds all of the valid .helmignore patterns present in the supplied Collection of such patterns.

Overrides must not call addPattern(String).

参数:

stringPatterns - a Collection of valid .helmignore patterns; may be null in which case no action will be taken

另请参阅:

matches(Path)

test

public final boolean test(Path path)

Calls the matches(Path) method with the supplied Path and returns its results.

指定者:

test 在接口中 Predicate<Path>

参数:

path - a Path to test; may be null

返回:

true if the supplied path matches; false otherwise

另请参阅:

matches(Path)

matches

public boolean matches(Path path)

Returns true if the supplied Path is neither null, the empty path ("") nor the "current directory" path ("." or "./"), and if at least one of the patterns added via the addPatterns(Collection) method logically matches it.

指定者:

matches 在接口中 PathMatcher

参数:

path - the Path to match; may be null in which case false will be returned

返回:

true if at least one of the patterns added via the addPatterns(Collection) method logically matches the supplied Path; false otherwise