com.github.robtimus.filesystems.memory.MemoryFileAttributeView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of memory-fs Show documentation
An in-memory NIO.2 file system
There is a newer version: 2.1
/*
 * MemoryFileAttributeView.java
 * Copyright 2016 Rob Spoor
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.robtimus.filesystems.memory;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.attribute.BasicFileAttributeView;

/**
 * A file attribute view that provides a view of the in-memory file attributes.
 * 
 * A {@code MemoryFileAttributeView} is a {@link BasicFileAttributeView} that additionally supports access to the set of in-memory attribute flags
 * that are used to indicate if the file is read-only, or hidden.
 * 

 * Where dynamic access to file attributes is required, the attributes supported by this attribute view are as defined by
 * {@code BasicFileAttributeView}, and in addition, the following attributes are supported:
 * 

 * 
 *   
 *   
 *   
 * Name Type
readOnly {@link Boolean}
hidden {@link Boolean}
 * 
 * The {@link Files#getAttribute getAttribute} method may be used to read any of these attributes, or any of the attributes defined by
 * {@link BasicFileAttributeView} as if by invoking the {@link #readAttributes()} method.
 * 
 * The {@link Files#setAttribute setAttribute} method may be used to update the file's last modified time, last access time or create time attributes
 * as defined by {@link BasicFileAttributeView}. It may also be used to update the in-memory attributes as if by invoking the
 * {@link #setReadOnly(boolean) setReadOnly}, and {@link #setHidden(boolean) setHidden} methods respectively.
 *
 * @author Rob Spoor
 */
public interface MemoryFileAttributeView extends BasicFileAttributeView {

    /**
     * Returns the name of the attribute view. Attribute views of this type have the name {@code "memory"}.
     */
    @Override
    String name();

    @Override
    MemoryFileAttributes readAttributes() throws IOException;

    /**
     * Updates the value of the read-only attribute.
     *
     * @param value The new value of the attribute.
     * @throws IOException If an I/O error occurs.
     */
    void setReadOnly(boolean value) throws IOException;

    /**
     * Updates the value of the hidden attribute.
     *
     * @param value The new value of the attribute.
     * @throws IOException If an I/O error occurs.
     */
    void setHidden(boolean value) throws IOException;
}