1 /*

     2  * Copyright 2007-2009 Sun Microsystems, Inc.  All Rights Reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    25 

    26 package java.nio.file.attribute;

    27 

    28 /**

    29  * Space related attributes of a file store.

    30  *

    31  * @since 1.7

    32  *

    33  * @see Attributes#readFileStoreSpaceAttributes

    34  */

    35 

    36 public interface FileStoreSpaceAttributes {

    37     /**

    38      * Returns the size, in bytes, of the file store.

    39      */

    40     long totalSpace();

    41 

    42     /**

    43      * Returns the number of bytes available to this Java virtual machine on the

    44      * file store.

    45      *

    46      * <p> The returned number of available bytes is a hint, but not a

    47      * guarantee, that it is possible to use most or any of these bytes.  The

    48      * number of usable bytes is most likely to be accurate immediately

    49      * after the space attributes are obtained. It is likely to be made inaccurate

    50      * by any external I/O operations including those made on the system outside

    51      * of this Java virtual machine.

    52      */

    53     long usableSpace();

    54 

    55     /**

    56      * Returns the number of unallocated bytes in the file store.

    57      *

    58      * <p> The returned number of unallocated bytes is a hint, but not a

    59      * guarantee, that it is possible to use most or any of these bytes.  The

    60      * number of unallocated bytes is most likely to be accurate immediately

    61      * after the space attributes are obtained. It is likely to be

    62      * made inaccurate by any external I/O operations including those made on

    63      * the system outside of this virtual machine.

    64      */

    65     long unallocatedSpace();

    66 }