Package org.sonar.api.batch.fs.internal

Class DefaultFilePredicates

java.lang.Object

org.sonar.api.batch.fs.internal.DefaultFilePredicates

All Implemented Interfaces:

FilePredicates

public class DefaultFilePredicates
extends java.lang.Object
implements FilePredicates

Factory of FilePredicate

Since:

4.2

Constructor Summary

Constructors

Constructor	Description
DefaultFilePredicates(java.nio.file.Path baseDir)	Client code should use FileSystem.predicates() to get an instance

Method Summary

Modifier and Type	Method	Description
FilePredicate	all()	Returns a predicate that always evaluates to true
FilePredicate	and(java.util.Collection<FilePredicate> and)
FilePredicate	and(FilePredicate... and)
FilePredicate	and(FilePredicate first, FilePredicate second)
FilePredicate	doesNotMatchPathPattern(java.lang.String exclusionPattern)	Predicate that gets the files that do not match the given wildcard pattern.
FilePredicate	doesNotMatchPathPatterns(java.lang.String[] exclusionPatterns)	Predicate that gets the files that do not match any of the given wildcard patterns.
FilePredicate	hasAbsolutePath(java.lang.String s)	Predicate that find file by its absolute path.
FilePredicate	hasAnyStatus()	Explicitely look for InputFile having any InputFile.status()
FilePredicate	hasExtension(java.lang.String s)	Predicate that matches files by extension (case insensitive).
FilePredicate	hasFilename(java.lang.String s)	Predicate that matches files by filename, in any directory.
FilePredicate	hasLanguage(java.lang.String language)
FilePredicate	hasLanguages(java.lang.String... languages)
FilePredicate	hasLanguages(java.util.Collection<java.lang.String> languages)
FilePredicate	hasPath(java.lang.String s)	if the parameter represents an absolute path for the running environment, then returns FilePredicates.hasAbsolutePath(String), else FilePredicates.hasRelativePath(String)
FilePredicate	hasRelativePath(java.lang.String s)	non-normalized path and Windows-style path are supported
FilePredicate	hasStatus(InputFile.Status status)	Look for InputFile having a specific InputFile.status()
FilePredicate	hasType(InputFile.Type type)
FilePredicate	hasURI(java.net.URI uri)	Predicate that gets a file by its IndexedFile.uri().
FilePredicate	is(java.io.File ioFile)	Warning - may not be supported in SonarLint
FilePredicate	matchesPathPattern(java.lang.String inclusionPattern)	Predicate that gets the files which "path" matches a wildcard pattern.
FilePredicate	matchesPathPatterns(java.lang.String[] inclusionPatterns)	Predicate that gets the files matching at least one wildcard pattern.
FilePredicate	none()	Returns a predicate that always evaluates to false
FilePredicate	not(FilePredicate p)
FilePredicate	or(java.util.Collection<FilePredicate> or)
FilePredicate	or(FilePredicate... or)
FilePredicate	or(FilePredicate first, FilePredicate second)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFilePredicates

public DefaultFilePredicates(java.nio.file.Path baseDir)

Client code should use FileSystem.predicates() to get an instance

Method Detail

all

public FilePredicate all()

Returns a predicate that always evaluates to true

Specified by:

all in interface FilePredicates

none

public FilePredicate none()

Returns a predicate that always evaluates to false

Specified by:

none in interface FilePredicates

hasAbsolutePath

public FilePredicate hasAbsolutePath(java.lang.String s)

Description copied from interface: FilePredicates

Predicate that find file by its absolute path. The parameter accepts forward/back slashes as separator and non-normalized values (/path/to/../foo.txt is same as /path/foo.txt).

Warning - may not be supported in SonarLint

Specified by:

hasAbsolutePath in interface FilePredicates

hasRelativePath

public FilePredicate hasRelativePath(java.lang.String s)

non-normalized path and Windows-style path are supported

Specified by:

hasRelativePath in interface FilePredicates

hasFilename

public FilePredicate hasFilename(java.lang.String s)

Description copied from interface: FilePredicates

Predicate that matches files by filename, in any directory. For example, the parameter Foo.java will match both some/path/Foo.java and other/path/Foo.java. The parameter must match exactly, no patterns are allowed, and it must not be null.

Specified by:

hasFilename in interface FilePredicates

hasExtension

public FilePredicate hasExtension(java.lang.String s)

Description copied from interface: FilePredicates

Predicate that matches files by extension (case insensitive). For example, the parameter java will match some/path/Foo.java and other/path/Foo.JAVA but not some/path/Foo.js. The parameter must not be null.

Specified by:

hasExtension in interface FilePredicates

hasURI

public FilePredicate hasURI(java.net.URI uri)

Description copied from interface: FilePredicates

Predicate that gets a file by its IndexedFile.uri().

Specified by:

hasURI in interface FilePredicates

matchesPathPattern

public FilePredicate matchesPathPattern(java.lang.String inclusionPattern)

Description copied from interface: FilePredicates

Predicate that gets the files which "path" matches a wildcard pattern.

The path is the path part of the IndexedFile.uri(). Pattern is case-sensitive, except for file extension.

Supported wildcards are * and **, but not ?.
Examples:

• **/*Foo.java matches Foo.java, src/Foo.java and src/java/SuperFoo.java
• **/*Foo*.java matches src/Foo.java, src/BarFoo.java, src/FooBar.java and src/BarFooBaz.java
• **/*FOO.JAVA matches FOO.java and FOO.JAVA but not Foo.java

Specified by:

matchesPathPattern in interface FilePredicates

matchesPathPatterns

public FilePredicate matchesPathPatterns(java.lang.String[] inclusionPatterns)

Description copied from interface: FilePredicates

Predicate that gets the files matching at least one wildcard pattern. No filter is applied when zero wildcard patterns (similar to FilePredicates.all().

Specified by:

matchesPathPatterns in interface FilePredicates

See Also:

FilePredicates.matchesPathPattern(String)

doesNotMatchPathPattern

public FilePredicate doesNotMatchPathPattern(java.lang.String exclusionPattern)

Description copied from interface: FilePredicates

Predicate that gets the files that do not match the given wildcard pattern.

Specified by:

doesNotMatchPathPattern in interface FilePredicates

See Also:

FilePredicates.matchesPathPattern(String)

doesNotMatchPathPatterns

public FilePredicate doesNotMatchPathPatterns(java.lang.String[] exclusionPatterns)

Description copied from interface: FilePredicates

Predicate that gets the files that do not match any of the given wildcard patterns. No filter is applied when zero wildcard patterns (similar to FilePredicates.all().

Specified by:

doesNotMatchPathPatterns in interface FilePredicates

See Also:

FilePredicates.matchesPathPattern(String)

hasPath

public FilePredicate hasPath(java.lang.String s)

Description copied from interface: FilePredicates

if the parameter represents an absolute path for the running environment, then returns FilePredicates.hasAbsolutePath(String), else FilePredicates.hasRelativePath(String)

Warning - may not be supported in SonarLint

Specified by:

hasPath in interface FilePredicates

is

public FilePredicate is(java.io.File ioFile)

Description copied from interface: FilePredicates

Warning - may not be supported in SonarLint

Specified by:

is in interface FilePredicates

hasLanguage

public FilePredicate hasLanguage(java.lang.String language)

Specified by:

hasLanguage in interface FilePredicates

hasLanguages

public FilePredicate hasLanguages(java.util.Collection<java.lang.String> languages)

Specified by:

hasLanguages in interface FilePredicates

hasLanguages

public FilePredicate hasLanguages(java.lang.String... languages)

Specified by:

hasLanguages in interface FilePredicates

hasType

public FilePredicate hasType(InputFile.Type type)

Specified by:

hasType in interface FilePredicates

not

public FilePredicate not(FilePredicate p)

Specified by:

not in interface FilePredicates

or

public FilePredicate or(java.util.Collection<FilePredicate> or)

Specified by:

or in interface FilePredicates

or

public FilePredicate or(FilePredicate... or)

Specified by:

or in interface FilePredicates

or

public FilePredicate or(FilePredicate first,
                        FilePredicate second)

Specified by:

or in interface FilePredicates

and

public FilePredicate and(java.util.Collection<FilePredicate> and)

Specified by:

and in interface FilePredicates

and

public FilePredicate and(FilePredicate... and)

Specified by:

and in interface FilePredicates

and

public FilePredicate and(FilePredicate first,
                         FilePredicate second)

Specified by:

and in interface FilePredicates

hasStatus

public FilePredicate hasStatus(InputFile.Status status)

Description copied from interface: FilePredicates

Look for InputFile having a specific InputFile.status()

Specified by:

hasStatus in interface FilePredicates

hasAnyStatus

public FilePredicate hasAnyStatus()

Description copied from interface: FilePredicates

Explicitely look for InputFile having any InputFile.status()

Specified by:

hasAnyStatus in interface FilePredicates