Annotation Type FileSystemInfo


  • @Retention(RUNTIME)
    @Target(TYPE)
    public @interface FileSystemInfo
    Specifies the info needed of a GFileSystem implementation.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.Class<? extends GFileSystemFactory<?>> factory
      The GFileSystemFactory class that will be responsible for probing and creating instances of this filesystem.
      java.lang.String type
      The 'type' of this filesystem, a short 1 word, lowercase string used in FSRLs to reference this filesystem, "[a-z0-9]+" only.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      A longer description of this filesystem.
      int priority
      The relative priority of filesystems during probing.
    • Field Detail

      • PRIORITY_DEFAULT

        static final int PRIORITY_DEFAULT
      • PRIORITY_HIGH

        static final int PRIORITY_HIGH
      • PRIORITY_LOW

        static final int PRIORITY_LOW
      • PRIORITY_LOWEST

        static final int PRIORITY_LOWEST
    • Element Detail

      • type

        java.lang.String type
        The 'type' of this filesystem, a short 1 word, lowercase string used in FSRLs to reference this filesystem, "[a-z0-9]+" only.
        Returns:
        Short 1 word lowercase String.
      • description

        java.lang.String description
        A longer description of this filesystem.

        Returns:
        Free form description string, defaults to empty string if not set.
        Default:
        ""
      • priority

        int priority
        The relative priority of filesystems during probing.

        Higher numeric values are considered before lower values.

        Returns:
        integer that specifies the relative ordering of filesystems during probing.
        Default:
        0