All Downloads are FREE. Search and download functionalities are using the official Maven repository.

oshi.software.os.FileSystem Maven / Gradle / Ivy

There is a newer version: 6.6.4
Show newest version
/**
 * MIT License
 *
 * Copyright (c) 2010 - 2020 The OSHI Project Contributors: https://github.com/oshi/oshi/graphs/contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package oshi.software.os;

import java.util.List;

import oshi.annotation.concurrent.ThreadSafe;

/**
 * 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.
 */
@ThreadSafe
public interface FileSystem {

    /**
     * Get file stores on this machine
     *
     * Instantiates an {@code UnmodifiableList} of
     * {@link oshi.software.os.OSFileStore} objects, representing a storage pool,
     * device, partition, volume, concrete file system or other implementation
     * specific means of file storage.
     *
     * @return An {@code UnmodifiableList} of {@link oshi.software.os.OSFileStore}
     *         objects or an empty array if none are present.
     */
    List getFileStores();

    /**
     * Get file stores on this machine
     *
     * Instantiates an {@code UnmodifiableList} of
     * {@link oshi.software.os.OSFileStore} objects, representing a storage pool,
     * device, partition, volume, concrete file system or other implementation
     * specific means of file storage.
     *
     * @param localOnly
     *            If true, filters the list to only local file stores.
     *
     * @return An {@code UnmodifiableList} of {@link oshi.software.os.OSFileStore}
     *         objects or an empty array if none are present.
     */
    List getFileStores(boolean localOnly);

    /**
     * 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.
     *
     * @return The number of open file descriptors if available, 0 otherwise.
     */
    long getOpenFileDescriptors();

    /**
     * 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.
     *
     * @return The maximum number of file descriptors if available, 0 otherwise.
     */
    long getMaxFileDescriptors();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy