ExecutionFileLocation

public interface ExecutionFileLocation extends FileLocation

saker.std.api.file.location.ExecutionFileLocation

saker.std.api.file.location.FileLocation

FileLocation that represents a file that is accessible in the build file hierarchy.

The path of the file is available using getPath().

Clients shouldn't implement this interface.

Use create(SakerPath) to construct a new instance.

Methods

public default void	accept(FileLocationVisitor visitor) Accepts a visitor and calls an appropriate `visit` method on it.
public static ExecutionFileLocation	create(SakerPath path) Creates a new execution file location.
public SakerPath	getPath() Gets the absolute execution path of the file.
public default SakerPath	toSakerPath() Use getPath() instead.

Inherited methods
From: FileLocation equals, hashCode

public default void accept(FileLocationVisitor visitor) throws NullPointerException

Overridden from: FileLocation

Accepts a visitor and calls an appropriate visit method on it.

visitorThe visitor.

NullPointerExceptionIf the visitor is null.

public static ExecutionFileLocation create(SakerPath path) throws NullPointerException, IllegalArgumentException

Creates a new execution file location.

The argument path must be absolute.

pathThe execution path of the file.

The created file location.

NullPointerExceptionIf the argument is null.

IllegalArgumentExceptionIf the argument is not absolute.

public abstract SakerPath getPath()

Gets the absolute execution path of the file.

The absolute path of the file.

@Deprecated

public default SakerPath toSakerPath()

Use getPath() instead.

Same as getPath().

This method is present to support automatic conversion to SakerPath using the DataConverterUtils class. This makes the execution file location assignable to task input parameters with the SakerPath type.

The path.