Enum Files.FileType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Files.FileType>
    Enclosing interface:
    Files

    public static enum Files.FileType
    extends java.lang.Enum<Files.FileType>
    Indicates how to resolve a path to a file.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Absolute
      Path that is a fully qualified, absolute filesystem path.
      Classpath
      Path relative to the root of the classpath.
      External
      Path relative to the root of the app external storage on Android and to the home directory of the current user on the desktop.
      Internal
      Path relative to the asset directory on Android and to the application's root directory on the desktop.
      Local
      Path relative to the private files directory on Android and to the application's root directory on the desktop.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Files.FileType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Files.FileType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • Internal

        public static final Files.FileType Internal
        Path relative to the asset directory on Android and to the application's root directory on the desktop. On the desktop, if the file is not found, then the classpath is checked. This enables files to be found when using JWS or applets. Internal files are always readonly.
      • External

        public static final Files.FileType External
        Path relative to the root of the app external storage on Android and to the home directory of the current user on the desktop.
      • Absolute

        public static final Files.FileType Absolute
        Path that is a fully qualified, absolute filesystem path. To ensure portability across platforms use absolute files only when absolutely (heh) necessary.
      • Local

        public static final Files.FileType Local
        Path relative to the private files directory on Android and to the application's root directory on the desktop.
    • Method Detail

      • values

        public static Files.FileType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Files.FileType c : Files.FileType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Files.FileType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null