ExecutionDirectoryContext

package saker.build.runtime.execution

public interface ExecutionDirectoryContext extends ExecutionDirectoryPathContext

saker.build.runtime.execution.ExecutionDirectoryContext

saker.build.runtime.execution.ExecutionDirectoryPathContext

ExecutionContext

Container for the base directories used during build execution.

SakerDirectory

ExecutionContext

ExecutionDirectoryPathContext

Methods

public SakerDirectory	getExecutionBuildDirectory() Gets the base build directory specified for the build execution.
public SakerDirectory	getExecutionWorkingDirectory() Gets the base working directory specified for the build execution.
public NavigableMap<String, ? extends SakerDirectory>	getRootDirectories() Gets the root directories specified for the build execution.
public default NavigableSet<String>	getRootDirectoryNames() Gets the names of the root directories for the build execution.

Inherited methods
From: ExecutionDirectoryPathContext getExecutionBuildDirectoryPath, getExecutionWorkingDirectoryPath

@RMICacheResult

public abstract SakerDirectory getExecutionBuildDirectory()

Gets the base build directory specified for the build execution.

This build directory represents the one which was configured by the user. Tasks are not recommended to directly use this, as they themselves can be configured on a per-task basis.

To avoid checking null result of this method consider using SakerPathFiles.requireBuildDirectory(ExecutionDirectoryContext) which throws an appropriate exception if it is not available.

The base build directory for the build execution or null if not available.

@RMICacheResult

public abstract SakerDirectory getExecutionWorkingDirectory()

Gets the base working directory specified for the build execution.

This working directory represents the one which was configured by the user. Tasks are not recommended to directly use this, as they themselves can be configured on a per-task basis.

The base working directory for the build execution.

ExecutionPathConfiguration.getWorkingDirectory()

@RMICacheResult

@RMIWrap(RMITreeMapSerializeKeyRemoteValueWrapper.class)

public abstract NavigableMap<String, ? extends SakerDirectory> getRootDirectories()

Gets the root directories specified for the build execution.

This method returns the root directories which can be used to resolve absolute paths during task execution. The root names are normalized as specified by the rules of SakerPath.

An unmodifiable map of root directories.

ExecutionPathConfiguration.getRootNames()

SakerPath.normalizeRoot(String)

@RMIDefaultOnFailure

@RMIForbidden

public default NavigableSet<String> getRootDirectoryNames()

Overridden from: ExecutionDirectoryPathContext

Gets the names of the root directories for the build execution.

The names of the root directories are specified by the user at the start of the build execution. These root names should be used to resolve execution paths during the build.

An immutable set of root directory names.

ExecutionPathConfiguration