Package uk.ac.starlink.datanode.nodes

Class FileDataNode

  • All Implemented Interfaces:
    DataNode
    public class FileDataNode
extends DefaultDataNode
    A DataNode representing a file or directory in the Unix file system. If the FileDataNode represents a directory, then its children are the files which it contains.
    Version:
    $Id$
    Author:
    Mark Taylor (Starlink)

    • Constructor Detail

      • FileDataNode

        public FileDataNode​(java.io.File file)
             throws NoSuchDataException
        Initialises a FileDataNode from a File object.
        Parameters:
        file - a File object representing the file from which the node is to be created
        Throws:
        NoSuchDataException

    • Method Detail

      • allowsChildren

        public boolean allowsChildren()
        Description copied from class: DefaultDataNode
        The DefaultDataNode implementation of this method returns false.
        Specified by:
        allowsChildren in interface DataNode
        Overrides:
        allowsChildren in class DefaultDataNode
        Returns:
        true if the node is of a type which can have child nodes, false otherwise

      • getChildIterator

        public java.util.Iterator getChildIterator()
        Description copied from class: DefaultDataNode
        The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren() is false).
        Specified by:
        getChildIterator in interface DataNode
        Overrides:
        getChildIterator in class DefaultDataNode
        Returns:
        an Iterator over the children. Each object iterated over should be a DataNode. Behaviour is undefined if this method is called on an object for which allowsChildren returns false.

      • getParentObject

        public java.lang.Object getParentObject()
        Description copied from interface: DataNode
        Returns an object which is in some sense the parent of the one this node is based on. The parent is not a DataNode, it is something which may get fed to a DataNodeFactory to create DataNode. If no such object exists, which may well be the case, null should be returned.
        Specified by:
        getParentObject in interface DataNode
        Overrides:
        getParentObject in class DefaultDataNode
        Returns:
        an object which is the parent of this one, or null

      • getName

        public java.lang.String getName()
        Description copied from interface: DataNode
        Gets the name of this object. This is an intrinsic property of the object.
        Specified by:
        getName in interface DataNode
        Overrides:
        getName in class DefaultDataNode
        Returns:
        the name of the object

      • getNodeTLA

        public java.lang.String getNodeTLA()
        Returns either "DIR" or "FILE" for a directory or non-directory file respectively.
        Specified by:
        getNodeTLA in interface DataNode
        Overrides:
        getNodeTLA in class DefaultDataNode
        Returns:
        a short description of the file type

      • getNodeType

        public java.lang.String getNodeType()
        Description copied from interface: DataNode
        Returns a short sentence indicating what kind of node this is. The return value should be just a few words. As a rough guideline it should indicate what the implementing class is.
        Specified by:
        getNodeType in interface DataNode
        Overrides:
        getNodeType in class DefaultDataNode
        Returns:
        a short description of the type of this DataNode

      • setShowHidden

        public static void setShowHidden​(boolean showHidden)
        Determines whether hidden files are included in the list of children of a directory file node.
        Parameters:
        showHidden - true iff you want hidden files to be included in the child list