Module com.github.oshi
Package oshi.software.os

Interface FileSystem

All Known Implementing Classes:
AbstractFileSystem, AixFileSystem, FreeBsdFileSystem, LinuxFileSystem, MacFileSystem, OpenBsdFileSystem, SolarisFileSystem, WindowsFileSystem
@ThreadSafe public interface FileSystem
The File System is a logical arrangement, usually in a hierarchial tree, where files are placed for storage and retrieval. It may consist of one or more file stores.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<OSFileStore>
    getFileStores()
    Get file stores on this machine Instantiates a list of OSFileStore objects, representing a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage.
    List<OSFileStore>
    getFileStores(boolean localOnly)
    Get file stores on this machine Instantiates a list of OSFileStore objects, representing a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage.
    long
    getMaxFileDescriptors()
    The maximum number of open file descriptors.
    long
    getMaxFileDescriptorsPerProcess()
    The maximum number of open file descriptors per process.
    long
    getOpenFileDescriptors()
    The current number of open file descriptors.

  • Method Details

    • getFileStores

      List<OSFileStore> getFileStores()
      Get file stores on this machine Instantiates a list of OSFileStore objects, representing a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage.
      Returns:
      A list of OSFileStore objects or an empty array if none are present.

    • getFileStores

      List<OSFileStore> getFileStores(boolean localOnly)
      Get file stores on this machine Instantiates a list of OSFileStore objects, representing a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage.
      Parameters:
      localOnly - If true, filters the list to only local file stores.
      Returns:
      A list of OSFileStore objects or an empty array if none are present.

    • getOpenFileDescriptors

      long getOpenFileDescriptors()
      The current number of open file descriptors. A file descriptor is an abstract handle used to access I/O resources such as files and network connections. On UNIX-based systems there is a system-wide limit on the number of open file descriptors. On Windows systems, this method returns the total number of handles held by Processes. While Windows handles are conceptually similar to file descriptors, they may also refer to a number of non-I/O related objects.
      Returns:
      The number of open file descriptors if available, 0 otherwise.

    • getMaxFileDescriptors

      long getMaxFileDescriptors()
      The maximum number of open file descriptors. A file descriptor is an abstract handle used to access I/O resources such as files and network connections. On UNIX-based systems there is a system-wide limit on the number of open file descriptors. On Windows systems, this method returns the theoretical max number of handles (2^24-2^15 on 32-bit, 2^24-2^16 on 64-bit). There may be a lower per-process limit. While Windows handles are conceptually similar to file descriptors, they may also refer to a number of non-I/O related objects.
      Returns:
      The maximum number of file descriptors if available, 0 otherwise.

    • getMaxFileDescriptorsPerProcess

      long getMaxFileDescriptorsPerProcess()
      The maximum number of open file descriptors per process. This returns the upper limit which applies to each process. The actual limit of a process may be lower if configured.
      Returns:
      The maximum number of file descriptors of each process if available, 0 otherwise.