JkPathMatcher

java.lang.Object
- dev.jeka.core.api.file.JkPathMatcher

All Implemented Interfaces:

java.nio.file.PathMatcher
```
public final class JkPathMatcher
extends java.lang.Object
implements java.nio.file.PathMatcher
```
A collection of pre-defined PathMatchers, each associated with a label for human-readable identification.
Description:
- A PathMatcher is used to determine whether a Path matches a specific pattern.
- These matchers are typically based on glob patterns, which define string-based rules for matching path components.
- Each matcher is designed with a clear label to describe its behavior, making it easier to understand its purpose and usage.
Common Path Matchers:
1. JkPathMatcher.of(): Matches all entries (accepts any path).
2. JkPathMatcher.of(boolean positive, FileSystem fileSystem, Iterable<String> globPatterns): Matches entries based on one or more glob patterns, with optional inclusion or exclusion behavior (driven by the positive parameter).
3. JkPathMatcher.of(boolean positive, String... globPattern): A convenient overload of the method above, using the default file system.
Example of Usage:
```
 // Example: Creating a PathMatcher that accepts paths matching "*.java"
 JkPathMatcher matcher = JkPathMatcher.of(true, "*.java");

 // Example: Checking if a specific path matches
 boolean isMatched = matcher.matches(Paths.get("src/main/MyClass.java"));  // Returns true
 
```
See individual method documentation for specific behavior and usage details.

Field Summary

Fields
Modifier and Type Field and Description

static JkPathMatcher ACCEPT_ALL

Fields
Modifier and Type	Field and Description
`static JkPathMatcher`	`ACCEPT_ALL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JkPathMatcher`	`and(boolean positive, java.nio.file.FileSystem fileSystem, java.lang.String... patterns)`
`JkPathMatcher`	`and(boolean positive, java.lang.String... patterns)`
`JkPathMatcher`	`and(java.nio.file.PathMatcher other)`
`boolean`	`matches(java.nio.file.Path path)`
`JkPathMatcher`	`negate()`
`static JkPathMatcher`	`of()` A matcher accepting all entries.
`static JkPathMatcher`	`of(boolean positive, java.nio.file.FileSystem fileSystem, java.lang.Iterable<java.lang.String> globPatterns)` A matcher accepting/refusing if path matches at least one of the specified glob patterns within specified file system.
`static JkPathMatcher`	`of(boolean positive, java.nio.file.FileSystem fileSystem, java.lang.String... globPattern)`
`static JkPathMatcher`	`of(boolean positive, java.lang.String... globPattern)`
`static JkPathMatcher`	`of(java.nio.file.PathMatcher matcher)` Creates an instance from a `PathMatcher` instance.
`static JkPathMatcher`	`of(java.lang.String... globPatterns)` Shorthand for `of(true, patterns)`.
`static JkPathMatcher`	`ofNoDirectory(java.nio.file.LinkOption... linkOptions)` A matcher filtering out directories.
`JkPathMatcher`	`or(java.nio.file.PathMatcher other)`
`java.util.function.Predicate<java.nio.file.Path>`	`toPredicate()` Returns this matcher as a `Predicate`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACCEPT_ALL

public static final JkPathMatcher ACCEPT_ALL

Method Detail

of

public static JkPathMatcher of(java.nio.file.PathMatcher matcher)

Creates an instance from a PathMatcher instance.

of
```
public static JkPathMatcher of()
```
A matcher accepting all entries.

ofNoDirectory

public static JkPathMatcher ofNoDirectory(java.nio.file.LinkOption... linkOptions)

A matcher filtering out directories.

of

public static JkPathMatcher of(boolean positive,
                               java.nio.file.FileSystem fileSystem,
                               java.lang.String... globPattern)

See Also:: of(boolean, FileSystem, Iterable)

of

public static JkPathMatcher of(java.lang.String... globPatterns)

Shorthand for of(true, patterns).

of

public static JkPathMatcher of(boolean positive,
                               java.lang.String... globPattern)

See Also:: of(boolean, FileSystem, Iterable)

of
```
public static JkPathMatcher of(boolean positive,
                               java.nio.file.FileSystem fileSystem,
                               java.lang.Iterable<java.lang.String> globPatterns)
```
A matcher accepting/refusing if path matches at least one of the specified glob patterns within specified file system.

Parameters:

positive - If true matcher will accept files matching at least one of the specified patterns. If false matcher will accept files matching none of the specified pattern.

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

toPredicate

public java.util.function.Predicate<java.nio.file.Path> toPredicate()

Returns this matcher as a Predicate

matches
```
public boolean matches(java.nio.file.Path path)
```
Specified by:

matches in interface java.nio.file.PathMatcher

and

public JkPathMatcher and(java.nio.file.PathMatcher other)

or

public JkPathMatcher or(java.nio.file.PathMatcher other)

and

public JkPathMatcher and(boolean positive,
                         java.nio.file.FileSystem fileSystem,
                         java.lang.String... patterns)

and

public JkPathMatcher and(boolean positive,
                         java.lang.String... patterns)

negate
```
public JkPathMatcher negate()
```

Class JkPathMatcher

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACCEPT_ALL

Method Detail

of

of

ofNoDirectory

of

of

of

of

toString

toPredicate

matches

and

or

and

and

negate