Gets the raw byte contents of the file, implicitly synchronizing the file using the specified content database.

It is recommended that users call TaskExecutionUtilities.getBytes(SakerFile) instead.

Gets the content descriptors of the children of the specified directory.

Works the same way as TaskExecutionUtilities.getChildrenFileContents(SakerDirectory), and it is recommended for tasks to call that instead.

Gets the string contents of the file, implicitly synchronizing the file using the specified content database.

It is recommended that users call TaskExecutionUtilities.getContent(SakerFile) instead.

Unless the file reports getting the bytes efficient, this method gets the raw bytes of the file and decodes them as UTF-8.

Gets the children of the specified directory by resolving the names against the current path of the directory.

Only the direct children of the directory is included.

This method works in the same way as if SakerDirectory.getChildren() was called, and every entry key is resolved against the directory path.

Same as:

 getDirectoryChildrenByPath(dir, dir.getSakerPath())
 

Gets the children of the specified directory by resolving the names against the specified path.

Only the direct children of the directory is included.

This method works in the same way as if SakerDirectory.getChildren() was called, and every entry key is resolved against the base path.

Gets the children in the specified directory tree.

The result map will have the files mapped to a relative path compared to the argument directory. Any file that is a direct child of the directory will have a relative path with a single path name as their key.

This is a convenience function for calling:

 dir.getFilesRecursiveByPath(SakerPath.EMPTY, DirectoryVisitPredicate.everything())
 

Gets the children in the specified directory tree using the given predicate.

This is a convenience function for calling:

 dir.getFilesRecursiveByPath(SakerPath.EMPTY, predicate)
 

Gets the all of the children in the specified directory tree, resolving the relative paths against the argument.

This is a convenience function for calling:

 dir.getFilesRecursiveByPath(basepath, DirectoryVisitPredicate.everything())
 

Gets the path key for a local path.

Same as:

 LocalFileProvider.getInstance().getPathKey(path)
 

Gets the path key for a file provider and corresponding path.

Gets the path or any of its parent which is contained in a set for a specified path.

The argument must be naturally ordered.

Gets the entry for the path path or any of its parent which is contained in a map for a specified path.

The argument must be naturally ordered.

Gets a submap of the argument which only contains entries that are mapped to a absolute path.

The argument must be naturally ordered.

Gets a submap of the argument which only contains entries with keys that start with the argument directory path.

The argument must be naturally ordered.

Gets a submap of the argument which only contains entries with keys that start with the argument directory path.

The argument must be naturally ordered.

This method is same as getPathSubMapDirectoryChildren(NavigableMap<SakerPath, V>, SakerPath, boolean), but is specialized for concurrent navigable maps.

Gets a submap of the argument which only contains entries that are mapped to a relative path.

The argument must be naturally ordered.

Gets a subset of the argument paths which only contain absolute paths.

The argument must be naturally ordered.

Gets a subset of the argument which only contains paths that only contain paths that start with the argument directory path.

The argument must be naturally ordered.

Gets a subset of the argument paths which only contain relative paths.

The argument must be naturally ordered.

Gets a subset of the argument paths which only contain relative paths.

The argument must be naturally ordered.

Gets the root file provider key of a file provider by unwrapping it according the wrapping rules of file providers.

Checks if the argument map contains any absolute path key.

The argument must be naturally ordered.

If the argument is empty, false is returned.

Checks if the argument set contains any absolute path element.

The argument must be naturally ordered.

If the argument is empty, false is returned.

Checks if the specified path set doesn't contain paths which have different roots.

The argument must be naturally ordered.

If the argument is empty, then false is returned as it satisfies the condition.

Checks if the argument sorted path set has any non-forward relative path.

If there is an absolute path in the set, the result will be true.

Empty argument will result in false.

In any other cases if there is a path in it that starts with "..", true is returned.

Checks if the argument pahts set contains the specified path, or any parent path of it.

The argument must be naturally ordered.

Checks if the argument set contains the specified test path, or any subpath of it.

The argument must be naturally ordered.

Checks if the argument map contains any relative path keys.

The argument must be naturally ordered.

If the argument is empty, false is returned.

Checks if the argument set contains any relative path element.

The argument must be naturally ordered.

If the argument is empty, false is returned.

Checks if the argument set contains at least one path that is a subpath of the specified test path.

The argument must be naturally ordered.

Checks if all key paths in the argument map starts with the specified base path.

The argument must be naturally ordered.

If the path map is empty, true is returned.

Checks if all paths in the argument set starts with the specified base path.

The argument must be naturally ordered.

If the path set is empty, true is returned.

Checks if the argument sorted path set consists only of forward relative paths.

If the argument is empty, the result is true.

If the argument contains an absolute path, the result is false.

If the argument contains a path that is not forward relative, the result is false.

Checks if a specified file path is a direct children of a directory path.

This method returns true if and only if the file path starts with the directory path, and the path name count of the file is one greater than the directory path name count.

Checks if the specified path with the given file provider has the same location as the argument local path.

The file system of the argument Path object is not taken into account. It is always interpreted as a path on the local file system.

Checks if a location specified by a file provider and absolute path is same as the given path key.

Checks if the specified file provider-path pair point to the same location.

Checks if the argument file provider keys are the same.

The keys are checked for equality.

Checks if the file provider key represents the file provider as the file provider argument.

The key is checked for equality against the key of the argument file provider.

Checks if the argument file providers operate on the same files.

Their file provider keys are checked for equality.

Checks if the argument path key operate on the same file providers, and the second path is a subpath of the first (base) path.

Tests if second file provider-path pair is a subpath of the first base pair.

Comparator function for comparing the argument files by their name.

Opens an input stream to the contents of the file, implicitly synchronizing the file using the specified content database.

It is recommended that users call TaskExecutionUtilities.openInputStream(SakerFile) instead.

Pretty prints a file hierarchy to the specified stream.

If the file is a directory, the children and their children recursively will be printed, and indented in the output.

The file name, its identity hash, and the classname is printed to the output.

Converts a map by taking the subpath of the keys for a given path base.

The argument must be naturally ordered.

Converts a path set by taking the subpath of the paths for a given path base.

The argument must be naturally ordered.

Validation method for ensuring that the specified path is absolute.

Validation method for ensuring that the specified path is absolute.

Validation method for ensuring that the specified file is available through an absolute path.

A file has an absolute path if and only if it has every parent until one of the root directories for the execution, or is a root directory itself.

Validation method for ensuring that the specified file is available through an absolute path.

A file has an absolute path if and only if it has every parent until one of the root directories for the execution, or is a root directory itself.

Validation method for ensuring that the specified path is absolute.

Validation method for ensuring that the specified path is absolute.

Validation method for ensuring that the execution has a build directory configured for it.

Validation method for ensuring that the task has a build directory configured for it.

Validation method for ensuring that the task has a build directory path configured for it.

Validation method for ensuring that the specified path has a valid file name.

Validation method for ensuring that the specified path has a valid file name.

Validation method for ensuring that a specified path has a non-null parent.

Validation method for ensuring that a specified path has a non-null parent.

Validation method for ensuring that the specified path is relative.

Validation method for ensuring that the specified path is relative.

Validation method for ensuring that the specified file is available through a relative path.

A file has a relative path if and only if it has no parent, or none of its parents are a root directory of the execution.

Validation method for ensuring that the specified file is available through a relative path.

A file has a relative path if and only if it has no parent, or none of its parents are a root directory of the execution.

Validation method for ensuring that the specified path is relative.

Validation method for ensuring that the specified path is relative.

Validation method for ensuring that the specified file provider is a root file provider.

Validation method for ensuring that the specified file provider is a root file provider.

Validation method for a file name according to the rules of FileHandle.getName().

The name may not be null, empty, "." or "..", must not contain slash characters ('/', '\\'), and must not contain the colon (':') and semicolon (';') characters.

Validation method for a file name according to the rules of FileHandle.getName().

The name may not be null, empty, "." or "..", must not contain slash characters ('/', '\\'), and must not contain the colon (':') and semicolon (';') characters.

Resolves a file or directory name against the specified directory.

Tha names "." and ".." are specially handled meaning the directory itself, and its parent respectively.

In any other case a child file of the directory is returned.

Resolves a file or directory using the given absolute path.

It is recommended that users call TaskExecutionUtilities.resolveAtAbsolutePath(SakerPath) instead.

Same as resolveAtPath(TaskContext, SakerPath), but uses the specified base directory to resolve relative paths.

It is recommended that users call TaskExecutionUtilities.resolveAtPath(SakerDirectory, SakerPath) instead.

Resolves a file or directory at the given path.

It is recommended that users call TaskExecutionUtilities.resolveAtPath(SakerPath) instead.

If the path is relative, it will be resolved against the current task working directory.

If it is absolute, the execution root directories will be used as a base of resolution.

Resolves a file or directory using the given relative path against a base directory.

It is recommended that users call TaskExecutionUtilities.resolveAtRelativePath(SakerDirectory, SakerPath) instead.

Resolves a file or directory with the given path names against a base directory.

It is recommended that users call TaskExecutionUtilities.resolveAtRelativePathNames(SakerDirectory, Iterable<? extends String>) instead.

The path names are interpreted as if they were relative compared to the base directory.

Resolves a directory name on the specified directory.

Tha names "." and ".." are specially handled meaning the directory itself, and its parent respectively.

If the specified child of the directory is not a directory instance, then null is returned.

In any other case a child directory of the directory is returned.

Resolves a directory using the given absolute path.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtAbsolutePath(SakerPath) instead.

Resolves a directory using the given absolute path, creating it if necessary, overwriting already existing files.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtAbsolutePathCreate(SakerPath) instead.

Resolves a directory using the given absolute path, creating it if possible.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtAbsolutePathCreateIfAbsent(SakerPath) instead.

This method doesn't overwrite the already existing file at the path if it's not a directory.

Same as resolveDirectoryAtPath(TaskContext, SakerPath), but uses the specified base directory to resolve relative paths.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtPath(SakerDirectory, SakerPath) instead.

Resolves a directory at a given path.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtPath(SakerPath) instead.

If the path is relative, it will be resolved against the current task working directory.

If it is absolute, the execution root directories will be used as a base of resolution.

Same as resolveDirectoryAtPathCreate(TaskContext, SakerPath), but uses the specified base directory to resolve relative paths.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtPathCreate(SakerDirectory, SakerPath) instead.

Resolves a directory at a given path, creating it if necessary, overwriting already existing files.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtPathCreate(SakerPath) instead.

If the path is relative, it will be resolved against the current task working directory.

If it is absolute, the execution root directories will be used as a base of resolution.

Same as resolveDirectoryAtPathCreateIfAbsent(TaskContext, SakerPath), but uses the specified base directory to resolve relative paths.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtPathCreateIfAbsent(SakerDirectory, SakerPath) instead.

Resolves a directory at a given path, creating it if possible.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtPathCreateIfAbsent(SakerPath) instead.

This method doesn't overwrite the already existing file at the path if it's not a directory.

If the path is relative, it will be resolved against the current task working directory.

If it is absolute, the execution root directories will be used as a base of resolution.

Resolves a directory using the given relative path against a base directory.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtRelativePath(SakerDirectory, SakerPath) instead.

Resolves a directory using the given relative path against a base directory, creating it if necessary, overwriting already existing files.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtRelativePathCreate(SakerDirectory, SakerPath) instead.

Resolves a directory using the given relative path against a base directory, creating it if possible.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtRelativePathCreateIfAbsent(SakerDirectory, SakerPath) instead.

This method doesn't overwrite the already existing file at the path if it's not a directory.

Resolves a directory with the given path names against a base directory.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtRelativePathNames(SakerDirectory, Iterable<? extends String>) instead.

The path names are interpreted as if they were relative compared to the base directory.

Resolves a directory with the given path names against a base directory, creating it if necessary, overwriting already existing files.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtRelativePathNamesCreate(SakerDirectory, Iterable<? extends String>) instead.

The path names are interpreted as if they were relative compared to the base directory.

Resolves a directory with the given path names against a base directory, creating it if possible.

It is recommended that users call TaskExecutionUtilities.resolveDirectoryAtRelativePathNamesCreateIfAbsent(SakerDirectory, Iterable<? extends String>) instead.

This method doesn't overwrite the already existing file at the path if it's not a directory.

The path names are interpreted as if they were relative compared to the base directory.

Resolves a directory name on the specified directory, creating if necessary.

Tha names "." and ".." are specially handled meaning the directory itself, and its parent respectively.

If the file name is ".." and the directory has no parent, null is returned.

In any other case a child directory of the passed directory is returned or created.

Resolves a directory name on the specified directory, creating if possible.

Tha names "." and ".." are specially handled meaning the directory itself, and its parent respectively.

If the specified child of the directory is present and not a directory instance, then null is returned.

If the file name is ".." and the directory has no parent, null is returned.

In any other case a child directory of the passed directory is returned or created.

Resolves a file but not a directory name on the specified directory.

Tha names "." and ".." are specially handled meaning the directory itself, and its parent respectively. In these cases null is returned.

If the specified child of the directory is a directory instance, then null is returned.

In any other case a child file of the directory is returned.

Resolves a file but not a directory using the given absolute path.

It is recommended that users call TaskExecutionUtilities.resolveFileAtAbsolutePath(SakerPath) instead.

Same as resolveFileAtPath(TaskContext, SakerPath), but uses the specified base directory to resolve relative paths.

It is recommended that users call TaskExecutionUtilities.resolveFileAtPath(SakerDirectory, SakerPath) instead.

Resolves a file but not a directory at the given path.

It is recommended that users call TaskExecutionUtilities.resolveFileAtPath(SakerPath) instead.

If the path is relative, it will be resolved against the current task working directory.

If it is absolute, the execution root directories will be used as a base of resolution.

Resolves a file but not a directory using the given relative path against a base directory.

It is recommended that users call TaskExecutionUtilities.resolveFileAtRelativePath(SakerDirectory, SakerPath) instead.

Resolves a file but not a directory with the given path names against a base directory.

It is recommended that users call TaskExecutionUtilities.resolveFileAtRelativePathNames(SakerDirectory, Iterable<? extends String>) instead.

The path names are interpreted as if they were relative compared to the base directory.

Executes the synchronization of a directory to its denoted path using the given content database and synchronization predicate.

The actual path is determined using ContentDatabase.getPathConfiguration().

Clients should not call this method directly, but SakerDirectory.synchronize(DirectoryVisitPredicate) instead.

Executes the synchronization of a directory to its denoted path using the given content database.

The actual path is determined using ContentDatabase.getPathConfiguration().

Clients should not call this method directly, but SakerDirectory.synchronize() instead.

Executes the synchronization of a directory to the given path using the given content database and synchronization predicate.

Clients should not call this method directly, but SakerDirectory.synchronize(ProviderHolderPathKey, DirectoryVisitPredicate) instead.

Executes the synchronization of a file (but not a directory) to its denoted path using the given content database.

The actual path is determined using ContentDatabase.getPathConfiguration().

Clients should not call this method directly, but SakerFile.synchronize() instead.

Executes the synchronization of a file (but not a directory) to the specified path using the given content database.

Clients should not call this method directly, but SakerFile.synchronize(ProviderHolderPathKey) instead.

Converts the argument to an absolute path by optionally resolving it against the working directory of the task context.

If the argument path is already absolute, it is returned directly.

Transforms the parameter map by taking the content descriptor of the values.

The ordering of the returned map is the same as the argument.

This function has no conterpart in TaskExecutionUtilities. To retrieve content descriptors of files see TaskExecutionUtilities.toPathContentMap(Iterable<? extends SakerFile>).

Converts the given files to a map with their retrieved paths as keys and content descriptors as values.

Works the same way as TaskExecutionUtilities.toPathContentMap(Iterable<? extends SakerFile>), and it is recommended for tasks to call that instead.

Converts the given files to a map with their retrieved paths as keys.

Works the same way as TaskExecutionUtilities.toPathFileMap(Iterable<? extends SakerFile>), and it is recommended for tasks to call that instead.

Converts the argument path to a relative string if possible.

If the argument is already relative, it will be converted to string directly.

If it is absolute, the method will try to convert it to a relative one by checking if it is under the execution working directory. The resulting path string will be forward relative.

If this method is called from a build execution thread, the configured execution working directory will be used to convert the path to a relative string.

If the path is not a subpath of the execution working directory, it will be stringized as an absolute path.

If this method is not called from a build execution, it is equivalent to path.toString().

This method is useful when displaying paths to the user, as relative paths are often more meaningful.

Writes the contents of the file to the parameter stream, implicitly synchronizing the file using the specified content database.

It is recommended that users call TaskExecutionUtilities.writeTo(SakerFile, OutputStream) instead.