Module kivakit.resource
Package com.telenav.kivakit.filesystem.spi

Interface FolderService

All Superinterfaces:
Broadcaster, ByteSized, CreatedAt, Deletable, FileSystemObjectService, Listener, Modifiable, ModifiedAt, NamedObject, Receiver, Repeater, ResourcePathed, Transceiver, Transmitter, UriIdentified
public interface FolderService extends FileSystemObjectService
A service provider interface (SPI) for filesystem folders. In addition to the methods required by FileSystemObjectService, this interface requires:
Author:
jonathanl (shibo)
See Also:

  • Method Details

    • clear

      default FolderService clear()
      Clear the contents of this folder

    • file

      FileService file(FileName name)
      Returns:
      The file service for the given file name

    • files

      List<FileService> files()
      Returns:
      The files in this folder

    • files

      default List<FileService> files(Matcher<FilePath> matcher)
      Returns:
      The files in this folder that match the matcher

    • folder

      FolderService folder(FileName folder)
      Returns:
      The named sub-folder in this folder

    • folder

      FolderService folder(Folder folder)
      Returns:
      The named folder path within this folder

    • folders

      List<FolderService> folders()
      Returns:
      The folders in this folder

    • folders

      default List<FolderService> folders(Matcher<FilePath> matcher)
      Returns:
      The folders in this folder that match the matcher

    • hasFiles

      default boolean hasFiles()

    • hasSubFolders

      default boolean hasSubFolders()

    • isEmpty

      default boolean isEmpty()
      Returns:
      true if the folder is empty

    • isWritable

      Boolean isWritable()
      Returns:
      True if this folder can be written to

    • mkdirs

      default FolderService mkdirs()
      Returns:
      True if the folder was created, along with all necessary parent folders.

    • nestedFiles

      List<FileService> nestedFiles(Matcher<FilePath> matcher)
      Returns:
      Files in this folder that match the given matcher, recursively

    • nestedFolders

      List<FolderService> nestedFolders(Matcher<FilePath> matcher)
      Returns:
      Files in this folder that match the given matcher, recursively

    • renameTo

      default boolean renameTo(FolderService that)
      Parameters:
      that - The folder to rename this folder to
      Returns:
      True if the folder was renamed

    • temporaryFile

      default FileService temporaryFile(FileName baseName)
      Parameters:
      baseName - Base name of temporary file
      Returns:
      A unique, existing temporary file in this folder

    • temporaryFolder

      default FolderService temporaryFolder(FileName baseName)
      Parameters:
      baseName - Base name of temporary folder
      Returns:
      A unique, existing temporary folder in this folder