org.microbean.helm.chart

Class HelmIgnorePathMatcher

java.lang.Object

org.microbean.helm.chart.HelmIgnorePathMatcher

All Implemented Interfaces:

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.

Author:

Laird Nelson

See Also:

The Helm project's package concerned with {@code .helmignore} files

Constructor Summary

Constructors

Constructor and Description
HelmIgnorePathMatcher() Creates a new HelmIgnorePathMatcher.
HelmIgnorePathMatcher(Collection<? extends String> stringPatterns) Creates a new HelmIgnorePathMatcher.
HelmIgnorePathMatcher(Path helmIgnoreFile) Creates a new HelmIgnorePathMatcher.
HelmIgnorePathMatcher(Reader reader) Creates a new HelmIgnorePathMatcher.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

HelmIgnorePathMatcher

public HelmIgnorePathMatcher()

Creates a new HelmIgnorePathMatcher.

HelmIgnorePathMatcher

public HelmIgnorePathMatcher(Collection<? extends String> stringPatterns)

Creates a new HelmIgnorePathMatcher.

Parameters:

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

Throws:

PatternSyntaxException - if any of the patterns is invalid

HelmIgnorePathMatcher

public HelmIgnorePathMatcher(Reader reader)
                      throws IOException

Creates a new HelmIgnorePathMatcher.

Parameters:

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

Throws:

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.

Parameters:

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

Throws:

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

PatternSyntaxException - if any of the patterns is invalid

See Also:

HelmIgnorePathMatcher(Reader)

Method Detail

addPattern

public final void addPattern(String stringPattern)

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

Parameters:

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

See Also:

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).

Parameters:

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

See Also:

matches(Path)

test

public final boolean test(Path path)

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

Specified by:

test in interface Predicate<Path>

Parameters:

path - a Path to test; may be null

Returns:

true if the supplied path matches; false otherwise

See Also:

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.

Specified by:

matches in interface PathMatcher

Parameters:

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

Returns:

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