LocalFileLocation

public interface LocalFileLocation extends FileLocation

saker.std.api.file.location.LocalFileLocation

saker.std.api.file.location.FileLocation

FileLocation that represents a file on the local file system.

The local file system is the one that the build is currently running on.

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

Note that using local file locations may cause tasks that are remote dispatchabel to not use build clusters, as the local files may not be accessible from the clusters.

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 LocalFileLocation	create(SakerPath path) Creates a new local file location.
public SakerPath	getLocalPath() Gets the absolute local path of the file.

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 LocalFileLocation create(SakerPath path) throws NullPointerException, IllegalArgumentException

Creates a new local file location.

The argument path must be absolute. The method will not check if the path is actually a valid path on the local file system.

pathThe local path of the file.

The created file location.

NullPointerExceptionIf the argument is null.

IllegalArgumentExceptionIf the argument is not absolute.

public abstract SakerPath getLocalPath()

Gets the absolute local path of the file.

The absolute local file path.