oshi.software.os

Interface FileSystem

All Superinterfaces:

Serializable

All Known Implementing Classes:

FreeBsdFileSystem, LinuxFileSystem, MacFileSystem, SolarisFileSystem, WindowsFileSystem

public interface FileSystem
extends Serializable

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.

Author:

widdis[at]gmail[dot]com

Method Summary

Modifier and Type	Method and Description
OSFileStore[]	getFileStores() Get file stores on this machine Instantiates an array 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	getOpenFileDescriptors() The current number of open file descriptors.

Method Detail

getFileStores

OSFileStore[] getFileStores()

Get file stores on this machine Instantiates an array of OSFileStore objects, representing a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage.

Returns:

An array 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 0. While Windows handles are conceptually similar to file descriptors, they may also refer to a number of non-I/O related objects, and there does not appear to be a system-wide limit for open handles.

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 0. While Windows handles are conceptually similar to file descriptors, they may also refer to a number of non-I/O related objects, and there does not appear to be a system-wide limit for open handles.

Returns:

The maximum number of file descriptors if available, 0 otherwise.