Package de.xima.fc.common.filesystem

Interface ICommonFileSystemVolume<FD>

  • Type Parameters:
    FD - The type of the file descriptor for this file system.
    All Superinterfaces:
    Serializable
    public interface ICommonFileSystemVolume<FD>
extends Serializable
    Represents a volume of a file system, such as a Windows drive or FTP mount. Only contains metadata describing the volume, see ICommonFileSystem for the actual file system implementation.
    Since:
    8.3.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • root

        FD root()
        Gets the file descriptor for the root of this file system. The root is the top-level folder that contains all other files and folders.
        Returns:
        The file descriptor for the root.

      • entryFromPath

        FD entryFromPath​(String path)
        Gets the file descriptor for the given path. The file descriptor is a unique identifier for a file or directory in this file system. Passing null or the empty string is equivalent to calling root().
        Parameters:
        path - The path to get the file descriptor for.
        Returns:
        The file descriptor.
        Throws:
        IllegalArgumentException - If the path is invalid.

      • parentVolumeId

        String parentVolumeId()
        Gets the optional parent volume ID. This can be used to create a hierarchy of volumes, or to group volumes.
        Returns:
        The parent volume ID, or null if this volume has no parent.

      • protocol

        String protocol()
        Gets the protocol of the file system, such as "file" for a local file system, "ftp" for FTP, or "smb" for Samba. The protocol is arbitrary and can be any string that is recognized by the ICommonFileSystem implementation.
        Returns:
        The protocol of the file system.

      • volumeId

        String volumeId()
        Gets the ID of the volume, which must be unique among all volumes.
        Returns:
        The ID of the volume.