Package io.github.astrapi69.file.system

Class SystemFileExtensions

  • public final class SystemFileExtensions
extends java.lang.Object
    The class SystemFileExtensions provide methods for get system or user files.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.io.File getJavaHomeDir()
      Gets the installation directory for Java Runtime Environment (JRE) from the system as File object
      static java.io.File getRootDir()
      Gets the root directory from the system as File object
      static java.io.File getTempDir()
      Gets the temporary directory from the system as File object.
      static java.io.File getUserConfigurationDir()
      Gets the users configuration directory from the system as File object
      static java.io.File getUserConfigurationDir​(java.lang.String configurationDirname)
      Gets the users configuration directory from the system as File object
      static java.io.File getUserDownloadsDir()
      Gets the users downloads directory from the system as File object
      static java.io.File getUserDownloadsDir​(java.lang.String downloadsDirname)
      Gets the users downloads directory from the system as File object
      static java.io.File getUserHomeDir()
      Gets the user home directory from the system as File object
      static java.io.File getUserWorkingDir()
      Gets the user working directory from the system as File object
      static java.util.Optional<java.io.File> getWindowsRootDriveDir​(char driveLetter)
      Gets the drive directory from the given drive letter as Optional of File object.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_USER_CONFIGURATION_DIRECTORY_NAME

        public static final java.lang.String DEFAULT_USER_CONFIGURATION_DIRECTORY_NAME
        Constant for the default configuration directory from the current user. current value:".config"
        See Also:
        Constant Field Values

      • DEFAULT_USER_DOWNLOAD_DIRECTORY_NAME

        public static final java.lang.String DEFAULT_USER_DOWNLOAD_DIRECTORY_NAME
        Constant for the default download directory from the current user. current value:"Downloads"
        See Also:
        Constant Field Values

    • Method Detail

      • getJavaHomeDir

        public static java.io.File getJavaHomeDir()
        Gets the installation directory for Java Runtime Environment (JRE) from the system as File object
        Returns:
        the installation directory for Java Runtime Environment (JRE) from the system as File object

      • getTempDir

        public static java.io.File getTempDir()
        Gets the temporary directory from the system as File object.
        Returns:
        the temporary directory from the system.

      • getUserHomeDir

        public static java.io.File getUserHomeDir()
        Gets the user home directory from the system as File object
        Returns:
        the user home directory from the system as File object

      • getUserDownloadsDir

        public static java.io.File getUserDownloadsDir()
        Gets the users downloads directory from the system as File object
        Returns:
        the users downloads directory from the system as File object

      • getUserDownloadsDir

        public static java.io.File getUserDownloadsDir​(java.lang.String downloadsDirname)
        Gets the users downloads directory from the system as File object
        Parameters:
        downloadsDirname - The name of the downloads directory, if null or empty the default value 'Downloads' will be taken
        Returns:
        the users downloads directory from the system as File object

      • getUserConfigurationDir

        public static java.io.File getUserConfigurationDir​(java.lang.String configurationDirname)
        Gets the users configuration directory from the system as File object
        Parameters:
        configurationDirname - The name of the configuration directory, if null or empty the default value '.config' will be taken
        Returns:
        the users configuration directory from the system as File object

      • getUserConfigurationDir

        public static java.io.File getUserConfigurationDir()
        Gets the users configuration directory from the system as File object
        Returns:
        the users configuration directory from the system as File object

      • getUserWorkingDir

        public static java.io.File getUserWorkingDir()
        Gets the user working directory from the system as File object
        Returns:
        the user working directory from the system as File object

      • getRootDir

        public static java.io.File getRootDir()
        Gets the root directory from the system as File object
        Returns:
        the root directory from the system as File object

      • getWindowsRootDriveDir

        public static java.util.Optional<java.io.File> getWindowsRootDriveDir​(char driveLetter)
        Gets the drive directory from the given drive letter as Optional of File object. If not found an empty Optional will be returned
        Parameters:
        driveLetter - the drive letter
        Returns:
        the drive directory from the given drive letter as File object or an empty Optional if not found