Package com.tccc.kos.commons.core.vfs

Interface VFSSource

All Known Implementing Classes:
AbstractVFSSource, FilesystemVFSSource, KabVFSSource, LocalizationContext, PathRewritingVFSSource, ProxyVFSSource, StackedVFSSource, VFS
public interface VFSSource
Interface for returning in input stream for a given path. Allows anything with path lookup semantics to be mounted in the VFS.
Since:
1.0
Version:
2022-08-30

  • Method Details

    • getParent

      VFSParent getParent()
      Gets the parent.
      Returns:
      the parent

    • setParent

      void setParent(VFSParent parent)
      Sets the parent.

    • getInputStream

      InputStream getInputStream(String path)
      Returns an input stream for the specified path.
      Parameters:
      path - the requested path
      Returns:
      the input stream or null if not found

    • isEnabled

      boolean isEnabled()
      Return true if the source is enabled. Disabled sources will not be accessible.

    • getBasePath

      default String getBasePath()
      Returns the base path of this source.

    • getDetails

      default JsonViewWrapper getDetails()
      Return details for the json view.

    • getFullPath

      default String getFullPath(String path)
      Returns the full path of a source relative path.
      Parameters:
      path - the source relative path

    • onUnmount

      default void onUnmount(String path)
      Called when the source is unmounted.
      Parameters:
      path - the mount point