org.sonar.api.batch.fs.internal
Class RelativePathPredicate

java.lang.Object
  org.sonar.api.batch.fs.internal.AbstractFilePredicate
      org.sonar.api.batch.fs.internal.RelativePathPredicate

All Implemented Interfaces:

Comparable<OptimizedFilePredicate>, FilePredicate, OptimizedFilePredicate

public class RelativePathPredicate
extends AbstractFilePredicate

Since:

4.2

Field Summary

Fields inherited from class org.sonar.api.batch.fs.internal.AbstractFilePredicate

DEFAULT_PRIORITY, USE_INDEX

Method Summary

boolean	apply(InputFile f) Test if provided file is valid for this predicate
Iterable<InputFile>	get(FileSystem.Index index) Get all files that are valid for this predicate.
String	path()
int	priority() For optimization.

Methods inherited from class org.sonar.api.batch.fs.internal.AbstractFilePredicate

compareTo, filter

Methods inherited from class java.lang.Object

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

Method Detail

path

public String path()

apply

public boolean apply(InputFile f)

Description copied from interface: FilePredicate

Test if provided file is valid for this predicate

get

public Iterable<InputFile> get(FileSystem.Index index)

Description copied from interface: OptimizedFilePredicate

Get all files that are valid for this predicate.

Specified by:

get in interface OptimizedFilePredicate

Overrides:

get in class AbstractFilePredicate

priority

public int priority()

Description copied from interface: OptimizedFilePredicate

For optimization. FilePredicates will be applied in priority order. For example when doing p.and(p1, p2, p3) then p1, p2 and p3 will be applied according to their priority value. Higher priority value are applied first. Assign a high priority when the predicate will likely highly reduce the set of InputFiles to filter. Also RelativePathPredicate and AbsolutePathPredicate have a high priority since they are using cache index.

Specified by:

priority in interface OptimizedFilePredicate

Overrides:

priority in class AbstractFilePredicate