Class FileTreeIterator.FileEntry

    • Constructor Detail

      • FileEntry

        public FileEntry​(File f,
                         FS fs)
        Create a new file entry.
        Parameters:
        f - file
        fs - file system
      • FileEntry

        public FileEntry​(File f,
                         FS fs,
                         FileTreeIterator.FileModeStrategy fileModeStrategy)
        Create a new file entry given the specified FileModeStrategy
        Parameters:
        f - file
        fs - file system
        fileModeStrategy - the strategy to use when determining the FileMode of a file; controls gitlinks etc.
        Since:
        4.3
      • FileEntry

        public FileEntry​(File f,
                         FS fs,
                         FS.Attributes attributes,
                         FileTreeIterator.FileModeStrategy fileModeStrategy)
        Create a new file entry given the specified FileModeStrategy
        Parameters:
        f - file
        fs - file system
        attributes - of the file
        fileModeStrategy - the strategy to use when determining the FileMode of a file; controls gitlinks etc.
        Since:
        5.0
    • Method Detail

      • getMode

        public FileMode getMode()
        Description copied from class: WorkingTreeIterator.Entry
        Get the type of this entry.

        Note: Efficient implementation required.

        The implementation of this method must be efficient. If a subclass needs to compute the value they should cache the reference within an instance member instead.

        Specified by:
        getMode in class WorkingTreeIterator.Entry
        Returns:
        a file mode constant from FileMode.
      • getName

        public String getName()
        Description copied from class: WorkingTreeIterator.Entry
        Get the name of this entry within its directory.

        Efficient implementations are not required. The caller will obtain the name only once and cache it once obtained.

        Specified by:
        getName in class WorkingTreeIterator.Entry
        Returns:
        name of the entry.
      • getLength

        public long getLength()
        Description copied from class: WorkingTreeIterator.Entry
        Get the byte length of this entry.

        Note: Efficient implementation required.

        The implementation of this method must be efficient. If a subclass needs to compute the value they should cache the reference within an instance member instead.

        Specified by:
        getLength in class WorkingTreeIterator.Entry
        Returns:
        size of this file, in bytes.
      • getLastModified

        @Deprecated
        public long getLastModified()
        Deprecated.
        Description copied from class: WorkingTreeIterator.Entry
        Get the last modified time of this entry.

        Note: Efficient implementation required.

        The implementation of this method must be efficient. If a subclass needs to compute the value they should cache the reference within an instance member instead.

        Specified by:
        getLastModified in class WorkingTreeIterator.Entry
        Returns:
        time since the epoch (in ms) of the last change.
      • getLastModifiedInstant

        public Instant getLastModifiedInstant()
        Description copied from class: WorkingTreeIterator.Entry
        Get the last modified time of this entry.

        Note: Efficient implementation required.

        The implementation of this method must be efficient. If a subclass needs to compute the value they should cache the reference within an instance member instead.

        Specified by:
        getLastModifiedInstant in class WorkingTreeIterator.Entry
        Returns:
        time of the last change.
        Since:
        5.1.9
      • openInputStream

        public InputStream openInputStream()
                                    throws IOException
        Description copied from class: WorkingTreeIterator.Entry
        Obtain an input stream to read the file content.

        Efficient implementations are not required. The caller will usually obtain the stream only once per entry, if at all.

        The input stream should not use buffering if the implementation can avoid it. The caller will buffer as necessary to perform efficient block IO operations.

        The caller will close the stream once complete.

        Specified by:
        openInputStream in class WorkingTreeIterator.Entry
        Returns:
        a stream to read from the file.
        Throws:
        IOException - the file could not be opened for reading.
      • getFile

        public File getFile()
        Get the underlying file of this entry.
        Returns:
        the underlying file of this entry