Class WorkingTreeIterator.Entry

java.lang.Object
org.eclipse.jgit.treewalk.WorkingTreeIterator.Entry
Direct Known Subclasses:
FileTreeIterator.FileEntry
Enclosing class:
WorkingTreeIterator

public abstract static class WorkingTreeIterator.Entry extends Object
A single entry within a working directory tree.
Since:
5.0
  • Field Details

    • encodedName

      byte[] encodedName
    • encodedNameLen

      int encodedNameLen
  • Constructor Details

    • Entry

      public Entry()
  • Method Details

    • encodeName

      void encodeName(CharsetEncoder enc)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getMode

      public abstract FileMode getMode()
      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.

      Returns:
      a file mode constant from FileMode.
    • getLength

      public abstract long getLength()
      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.

      Returns:
      size of this file, in bytes.
    • getLastModified

      @Deprecated public abstract long getLastModified()
      Deprecated.
      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.

      Returns:
      time since the epoch (in ms) of the last change.
    • getLastModifiedInstant

      public abstract Instant getLastModifiedInstant()
      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.

      Returns:
      time of the last change.
      Since:
      5.1.9
    • getName

      public abstract String getName()
      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.

      Returns:
      name of the entry.
    • openInputStream

      public abstract InputStream openInputStream() throws IOException
      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.

      Returns:
      a stream to read from the file.
      Throws:
      IOException - the file could not be opened for reading.