Home | History | Annotate | Download | only in attribute
      1 /*
      2  * Copyright (c) 2007, 2011, Oracle and/or its affiliates. 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.  Oracle designates this
      8  * particular file as subject to the "Classpath" exception as provided
      9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
     22  * or visit www.oracle.com if you need additional information or have any
     23  * questions.
     24  */
     25 
     26 package java.nio.file.attribute;
     27 
     28 /**
     29  * File attributes associated with a file in a file system that supports
     30  * legacy "DOS" attributes.
     31  *
     32  * <p> <b>Usage Example:</b>
     33  * <pre>
     34  *    Path file = ...
     35  *    DosFileAttributes attrs = Files.readAttributes(file, DosFileAttributes.class);
     36  * </pre>
     37  *
     38  * @since 1.7
     39  */
     40 
     41 public interface DosFileAttributes
     42     extends BasicFileAttributes
     43 {
     44     /**
     45      * Returns the value of the read-only attribute.
     46      *
     47      * <p> This attribute is often used as a simple access control mechanism
     48      * to prevent files from being deleted or updated. Whether the file system
     49      * or platform does any enforcement to prevent <em>read-only</em> files
     50      * from being updated is implementation specific.
     51      *
     52      * @return  the value of the read-only attribute
     53      */
     54     boolean isReadOnly();
     55 
     56     /**
     57      * Returns the value of the hidden attribute.
     58      *
     59      * <p> This attribute is often used to indicate if the file is visible to
     60      * users.
     61      *
     62      * @return  the value of the hidden attribute
     63      */
     64     boolean isHidden();
     65 
     66     /**
     67      * Returns the value of the archive attribute.
     68      *
     69      * <p> This attribute is typically used by backup programs.
     70      *
     71      * @return  the value of the archive attribute
     72      */
     73     boolean isArchive();
     74 
     75     /**
     76      * Returns the value of the system attribute.
     77      *
     78      * <p> This attribute is often used to indicate that the file is a component
     79      * of the operating system.
     80      *
     81      * @return  the value of the system attribute
     82      */
     83     boolean isSystem();
     84 }
     85