Class FileSystemAccessor

java.lang.Object
ch.nolix.base.environment.filesystem.FileSystemAccessor
public final class FileSystemAccessor extends Object
The FileSystemAccessor can access the file system on the local machine.
Author:
Silvan Wyss

  • Method Details

    • getFolderOfRunningJarFile

      public static FolderAccessor getFolderOfRunningJarFile()
      Returns:
      a new FolderAccessor to the folder of the running jar file.

    • getFolderPathOfRunningJarFile

      public static String getFolderPathOfRunningJarFile()
      Returns:
      the path of the folder of the running jar file.

    • openInFileExplorer

      public static void openInFileExplorer(String path)
      Opens the folder with the given path in a new file explorer.
      Parameters:
      path -

    • openFolderOfRunningJarFileInExplorer

      public static void openFolderOfRunningJarFileInExplorer()
      Opens the folder of the running jar file in a new file explorer.

    • createFile

      public static FileAccessor createFile(String path)
      Creates a new empty file with the given path.
      Parameters:
      path -
      Returns:
      a new FileAccessor to the created file.
      Throws:
      RuntimeException - if the given path is null.
      RuntimeException - if the given path is empty.
      RuntimeException - if there exists already a file system item with the given path.

    • createFile

      public static FileAccessor createFile(String path, WriteMode writeMode)
      Creates a new empty file with the given path.
      Parameters:
      path -
      writeMode -
      Returns:
      a new FileAccessor to the created file.
      Throws:
      RuntimeException - if the given path is null.
      RuntimeException - if the given path is blank.
      RuntimeException - if the given writeMode flag = WriteMode.THROW_EXCEPTION_WHEN_TARGET_EXISTS_ALREADY and there exists already a file system item with the given path.

    • createFile

      public static FileAccessor createFile(String path, WriteMode writeMode, byte[] content)
      Creates a new file with the given path. The file will have the given content.
      Parameters:
      path -
      writeMode -
      content -
      Returns:
      a new FileAccessor to the created file.
      Throws:
      RuntimeException - if the given path is null.
      RuntimeException - if the given path is blank.
      RuntimeException - if the given writeMode = WriteMode.THROW_EXCEPTION_WHEN_TARGET_EXISTS_ALREADY and there exists already a file system item with the given path.
      RuntimeException - if the given content is null.

    • createFile

      public static FileAccessor createFile(String path, WriteMode writeMode, String content)
      Creates a new file with the given path. The file will have the given content.
      Parameters:
      path -
      writeMode -
      content -
      Returns:
      a new FileAccessor to the created file.
      Throws:
      RuntimeException - if the given path is null.
      RuntimeException - if the given path is blank.
      RuntimeException - if the given writeMode = WriteMode.THROW_EXCEPTION_WHEN_TARGET_EXISTS_ALREADY and there exists already a file system item with the given path.
      RuntimeException - if the given content is null.

    • createFile

      public static FileAccessor createFile(String path, byte[] content)
      Creates a new file with the given path. The file will have the given content.
      Parameters:
      path -
      content -
      Returns:
      a new FileAccessor to the created file.
      Throws:
      RuntimeException - if the given path is null.
      RuntimeException - if the given path is empty.
      RuntimeException - if there exists already a file system item with the given path.

    • createFile

      public static FileAccessor createFile(String path, String content)
      Creates a new file with the given path. The file will have the given content.
      Parameters:
      path -
      content -
      Returns:
      a new FileAccessor to the created file.
      Throws:
      RuntimeException - if the given path is null.
      RuntimeException - if the given path is blank.
      RuntimeException - if there exists already a file system item with the given path.

    • createFolder

      public static FolderAccessor createFolder(String path)
      Creates a new empty folder with the given path.
      Parameters:
      path -
      Returns:
      a new FileAccessor to the created folder.
      Throws:
      RuntimeException - if there exists already a file system item with the given path.

    • deleteFileSystemItem

      public static void deleteFileSystemItem(String path)
      Deletes the file system item with the given path if it exists.
      Parameters:
      path -

    • exists

      public static boolean exists(String path)
      Parameters:
      path -
      Returns:
      true if there exists a file system item with given path, false otherwise.

    • getFileAccessors

      public static IContainer<FileAccessor> getFileAccessors(String path)
      Parameters:
      path -
      Returns:
      new FileAccessors for the files in the folder with the given path.

    • getFileAccessors

      public static IContainer<FileAccessor> getFileAccessors(String path, String extension)
      Parameters:
      path -
      extension -
      Returns:
      new FileAccessors for the files in the folder with the given path, that have the given extension.

    • getFileAccessorsRecursively

      public static ILinkedList<FileAccessor> getFileAccessorsRecursively(String path)
      Parameters:
      path -
      Returns:
      new FileAccessors for the files in the folder with the given path recursively.

    • getFileSystemItemAccessors

      public static IContainer<FileSystemItemAccessor> getFileSystemItemAccessors(String path)
      Parameters:
      path -
      Returns:
      new FileSystemItemAccessors for the file system items in the folder with the given path.

    • isFile

      public static boolean isFile(String path)
      Parameters:
      path -
      Returns:
      true if there exists a file with the given path, false otherwise.

    • isFolder

      public static boolean isFolder(String path)
      Parameters:
      path -
      Returns:
      true if there exists a folder with the given path, false otherwise.

    • overwriteFile

      public static void overwriteFile(String path, byte[] content)

    • overwriteFile

      public static void overwriteFile(String path, String content)
      Overwrites the file with the given path. Creates a new file with the given path if it does not exists. The file will get the given content.
      Parameters:
      path -
      content -
      Throws:
      RuntimeException - if there exists already a folder with the given path.

    • readFileToBytes

      public static byte[] readFileToBytes(String filePath)
      Reads the content of the file with the given filePath to bytes.
      Parameters:
      filePath -
      Returns:
      the bytes of the file with the given filePath.
      Throws:
      RuntimeException - if there does not exist a file with the given filePath in the file system on the local machine.

    • readFileToLines

      public static ILinkedList<String> readFileToLines(String path)
      Reads the content of the file with the given path to lines.
      Parameters:
      path -
      Returns:
      the lines of the file with the given path.
      Throws:
      RuntimeException - if there does not exist a file with the given path.