Package org.veupathdb.lib.compute.platform.job

Interface JobWorkspace

  • All Implemented Interfaces:
    
public interface JobWorkspace

    Local Scratch Workspace

    Represents a handle on a local workspace and provides methods for operating on files and directories in that workspace.

    Since:

    1.0.0

    Author:

    Elizabeth Paige Harper https://github.com/foxcapades

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Path touch(String path) Creates an empty file in this workspace at the given path.
      abstract Unit delete(String path) Deletes the file at the given path if such a file exists.
      abstract Path mkdir(String path) Creates an empty directory at the given path.
      abstract Path write(String path, InputStream data) Writes the contents of the given stream to the file at the given path.
      abstract Path write(String path, Consumer<OutputStream> consumer) Opens an output stream to the given path and passes it to the consumer, which can write arbitrary data to the file, then closes the stream.
      abstract Path write(String path, Reader data) Writes the contents of the given reader to the file at the given path.
      abstract Path write(String path, String data) Writes the given string to the file at the given path.
      abstract Path write(String path, JsonNode data) Writes the given JsonNode to the file at the given path.
      abstract Path copy(String fromPath, String toPath) Copies the file at the given fromPath to the given toPath.
      abstract InputStream openStream(String path) Opens an InputStream over the contents of the file at the given path.
      abstract Reader openReader(String path) Opens a Reader over the contents of the file at the given path.
      abstract String readAsString(String path) Reads the contents of the file at the given path into a String and returns it.
      abstract JsonNode readAsJson(String path) Reads the contents of the file at the given path as a JSON value and returns it.
      abstract Path getPath() Absolute path to this workspace on the local filesystem.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • touch

         abstract Path touch(String path)

        Creates an empty file in this workspace at the given path.

        Parameters:
        path - Relative path at which the empty file will be created.
        Returns:

        Path to the created file.

      • delete

         abstract Unit delete(String path)

        Deletes the file at the given path if such a file exists.

        If the target file does not exist, this method does nothing.

        Parameters:
        path - Relative path to the file that should be deleted.

      • mkdir

         abstract Path mkdir(String path)

        Creates an empty directory at the given path.

        Parameters:
        path - Relative path at which the directory will be created.
        Returns:

        Path to the created directory.

      • write

         abstract Path write(String path, InputStream data)

        Writes the contents of the given stream to the file at the given path.

        If the given path points to a file that already exists, it will be truncated before writing.

        If the given path points to a file that does not yet exist, it will be created.

        Parameters:
        path - Relative path at which the file should be written.
        data - Input stream over the data that will be written to the target file.
        Returns:

        Path to the written file.

      • write

         abstract Path write(String path, Consumer<OutputStream> consumer)

        Opens an output stream to the given path and passes it to the consumer, which can write arbitrary data to the file, then closes the stream.

        If the given path points to a file that already exists, it will be truncated before writing.

        If the given path points to a file that does not yet exist, it will be created.

        Parameters:
        path - Relative path at which the file should be written.
        consumer - Consumer of the created output stream which will write data to the target file via the stream.
        Returns:

        Path to the written file.

      • write

         abstract Path write(String path, Reader data)

        Writes the contents of the given reader to the file at the given path.

        If the given path points to a file that already exists, it will be truncated before writing.

        If the given path points to a file that does not yet exist, it will be created.

        Parameters:
        path - Relative path at which the file should be written.
        data - Reader over the data that will be written to the target file.
        Returns:

        Path to the written file.

      • write

         abstract Path write(String path, String data)

        Writes the given string to the file at the given path.

        If the given path points to a file that already exists, it will be truncated before writing.

        If the given path points to a file that does not yet exist, it will be created.

        Parameters:
        path - Relative path at which the file should be written.
        data - String that will be written to the target file.
        Returns:

        Path to the written file.

      • write

         abstract Path write(String path, JsonNode data)

        Writes the given JsonNode to the file at the given path.

        If the given path points to a file that already exists, it will be truncated before writing.

        If the given path points to a file that does not yet exist, it will be created.

        Parameters:
        path - Relative path at which the file should be written.
        data - Json data that will be written to the target file.
        Returns:

        Path to the written file.

      • copy

         abstract Path copy(String fromPath, String toPath)

        Copies the file at the given fromPath to the given toPath.

        Parameters:
        fromPath - Relative path to the file that will be copied.
        toPath - Relative path to where the file should be copied.
        Returns:

        Path to the new file copy.

      • openReader

         abstract Reader openReader(String path)

        Opens a Reader over the contents of the file at the given path.

        Parameters:
        path - Relative path to the file that will be opened.
        Returns:

        A Reader over the contents of the target file.

      • readAsString

         abstract String readAsString(String path)

        Reads the contents of the file at the given path into a String and returns it.

        Parameters:
        path - Relative path to the file that will be read.
        Returns:

        The String contents of the target file.

      • readAsJson

         abstract JsonNode readAsJson(String path)

        Reads the contents of the file at the given path as a JSON value and returns it.

        Parameters:
        path - Relative path to the file that will be read.
        Returns:

        The parsed JsonNode contents of the target file.

      • getPath

         abstract Path getPath()

        Absolute path to this workspace on the local filesystem.