PathFinder

sealed abstract class PathFinder extends PathLister with PathFinderDefaults

A path finder constructs a set of paths. The set is evaluated by a call to the get method. The set will be different for different calls to get if the underlying filesystem has changed.

Companion:
object
class Object
trait Matchable
class Any

Value members

Concrete methods

override def get(): Seq[File]

Evaluates this finder and converts the results to a Seq of distinct Files. The files returned by this method will reflect the underlying filesystem at the time of calling. If the filesystem changes, two calls to this method might be different.

Evaluates this finder and converts the results to a Seq of distinct Files. The files returned by this method will reflect the underlying filesystem at the time of calling. If the filesystem changes, two calls to this method might be different.

Definition Classes

Inherited methods

final def *(filter: FileFilter): PathFinder

Alias of glob

Alias of glob

Inherited from:
PathFinderDefaults
final def **(filter: FileFilter): PathFinder

Alias of globRecursive.

Alias of globRecursive.

Inherited from:
PathFinderDefaults
override def +++(paths: PathFinder): PathFinder

The union of the paths found by this PathFinder with the paths found by 'paths'.

The union of the paths found by this PathFinder with the paths found by 'paths'.

Definition Classes
Inherited from:
PathFinderDefaults
override def ---(excludePaths: PathFinder): PathFinder

Excludes all paths from excludePaths from the paths selected by this PathFinder.

Excludes all paths from excludePaths from the paths selected by this PathFinder.

Definition Classes
Inherited from:
PathFinderDefaults
def /(literal: String): PathFinder

Constructs a new finder that selects all paths with name literal that are immediate children of paths selected by this finder.

Constructs a new finder that selects all paths with name literal that are immediate children of paths selected by this finder.

Inherited from:
PathFinderDefaults
final def \(literal: String): PathFinder

Constructs a new finder that selects all paths with name literal that are immediate children of paths selected by this finder.

Constructs a new finder that selects all paths with name literal that are immediate children of paths selected by this finder.

Inherited from:
PathFinderDefaults
final def absString(): String

Constructs a string by evaluating this finder, converting the resulting Paths to absolute path strings, and joining them with the platform path separator.

Constructs a string by evaluating this finder, converting the resulting Paths to absolute path strings, and joining them with the platform path separator.

Inherited from:
PathFinderDefaults
override def descendantsExcept(include: FileFilter, intermediateExclude: FileFilter): PathFinder

Selects all descendant paths with a name that matches include and do not have an intermediate path with a name that matches intermediateExclude.

Selects all descendant paths with a name that matches include and do not have an intermediate path with a name that matches intermediateExclude.

Typical usage is descendantsExcept("*.jar", ".svn")

Definition Classes
Inherited from:
PathFinderDefaults
override def distinct(): PathFinder

Create a PathFinder from this one where each path has a unique name. A single path is arbitrarily selected from the set of paths with the same name.

Create a PathFinder from this one where each path has a unique name. A single path is arbitrarily selected from the set of paths with the same name.

Definition Classes
Inherited from:
PathFinderDefaults
final override def filter(f: File => Boolean): PathFinder

Only keeps paths for which f returns true. It is non-strict, so it is not evaluated until the returned finder is evaluated.

Only keeps paths for which f returns true. It is non-strict, so it is not evaluated until the returned finder is evaluated.

Definition Classes
Inherited from:
PathFinderDefaults
final override def flatMap(f: File => PathFinder): PathFinder

Non-strict flatMap: no evaluation occurs until the returned finder is evaluated.

Non-strict flatMap: no evaluation occurs until the returned finder is evaluated.

Definition Classes
Inherited from:
PathFinderDefaults
final override def getPaths(): Seq[String]

Evaluates this finder and converts the results to a distinct sequence of absolute path strings.

Evaluates this finder and converts the results to a distinct sequence of absolute path strings.

Definition Classes
Inherited from:
PathFinderDefaults
final override def getURLs(): Array[URL]

Evaluates this finder and converts the results to an Array of URLs.

Evaluates this finder and converts the results to an Array of URLs.

Definition Classes
Inherited from:
PathFinderDefaults
def glob(filter: FileFilter): PathFinder

Constructs a new finder that selects all paths with a name that matches filter and are immediate children of paths selected by this finder.

Constructs a new finder that selects all paths with a name that matches filter and are immediate children of paths selected by this finder.

Value parameters:
filter

only include files that this filter accepts

Inherited from:
PathFinderDefaults
def globRecursive(filter: FileFilter, walker: (File, FileFilter, Set[File]) => Unit): PathFinder

Constructs a new finder that selects all paths with a name that matches filter and are descendants of paths selected by this finder.

Constructs a new finder that selects all paths with a name that matches filter and are descendants of paths selected by this finder.

Value parameters:
filter

only include files that this filter accepts

walker

use this walker to traverse the file system

Inherited from:
PathFinderDefaults

Constructs a new finder that selects all paths with a name that matches filter and are descendants of paths selected by this finder.

Constructs a new finder that selects all paths with a name that matches filter and are descendants of paths selected by this finder.

Value parameters:
filter

only include files that this filter accepts

Inherited from:
PathFinderDefaults
def pair[T](mapper: File => Option[T], errorIfNone: Boolean): Seq[(File, T)]

Applies mapper to each path selected by this PathFinder and returns the path paired with the non-empty result. If the result is empty (None) and errorIfNone is true, an exception is thrown. If errorIfNone is false, the path is dropped from the returned Traversable.

Applies mapper to each path selected by this PathFinder and returns the path paired with the non-empty result. If the result is empty (None) and errorIfNone is true, an exception is thrown. If errorIfNone is false, the path is dropped from the returned Traversable.

Inherited from:
PathFinderDefaults