FSEntry.java example

Explorer
jnode-master
/*
 * $Id$
 *
 * Copyright (C) 2003-2015 JNode.org
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; If not, write to the Free Software Foundation, Inc., 
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package org.jnode.fs;

import java.io.IOException;

/**
 * @author epr
 */

/**
 * Entry of an FSDirectory.
 *
 * @author epr
 */
public interface FSEntry extends FSObject {

    /**
     * Gets a unique ID for this entry in the context of its parent. This value should be the same every time the
     * entry is accessed.
     *
     * @return the unique ID for this entry.
     */
    public String getId();

    /**
     * Gets the name of this entry.
     *
     * @return name of the entry.
     */
    public String getName();

    /**
     * Gets the directory this entry is a part of.
     *
     * @return {@link FSDirectory} that is the parent of the entry.
     */
    public FSDirectory getParent();

    /**
     * Gets the last modification time of this entry.
     *
     * @return the last modification time of the entry as milliseconds since 1970, or {@code 0}
     * if this files system does not support getting the last modified time.
     * @throws IOException if an error occurs retrieving the timestamp.
     */
    public long getLastModified() throws IOException;

    /**
     * Returns <tt>true</tt> if this entry referring to a file.
     *
     * @return <tt>true</tt> if this entry referring to a file.
     */
    public boolean isFile();

    /**
     * Returns <tt>true</tt> if this entry referring to a (sub-)directory.
     *
     * @return <tt>true</tt> if this entry referring to a (sub-)directory.
     */
    public boolean isDirectory();

    /**
     * Sets the name of this entry.
     *
     * @param newName new name that identify the entry.
     * @throws IOException if name already used.
     */
    public void setName(String newName) throws IOException;

    /**
     * Gets the last modification time of this entry.
     *
     * @param lastModified the last modified time of the entry in millisecond.
     * @throws IOException if error occurs during set of the timestamp.
     */
    public void setLastModified(long lastModified) throws IOException;

    /**
     * Gets the file this entry refers to.
     *
     * @return The file described by this entry.
     * @throws IOException if entry is not a file.
     */
    public FSFile getFile() throws IOException;

    /**
     * Gets the directory this entry refers to.
     *
     * @return The directory described by this entry.
     * @throws IOException of entry is not a directory.
     */
    public FSDirectory getDirectory() throws IOException;

    /**
     * Gets the access rights for this entry.
     *
     * @return {@link FSAccessRights} represent rights for this entry.
     * @throws IOException if access rights are unavailable.
     */
    public FSAccessRights getAccessRights() throws IOException;

    /**
     * Returns <tt>true</tt> if the entry has been modified in memory and need to be saved.
     *
     * @return <tt>true</tt> if the entry need to be saved
     * @throws IOException if error occurs during retrieving of the state of the entry.
     */
    public boolean isDirty() throws IOException;
}