Class DepthWalk.RevWalk

java.lang.Object
org.eclipse.jgit.revwalk.RevWalk
org.eclipse.jgit.revwalk.DepthWalk.RevWalk
All Implemented Interfaces:
AutoCloseable, Iterable<RevCommit>, DepthWalk
Enclosing interface:
DepthWalk

public static class DepthWalk.RevWalk extends RevWalk implements DepthWalk
Subclass of RevWalk that performs depth filtering.
  • Field Details

    • depth

      private final int depth
    • deepenSince

      private int deepenSince
    • deepenNots

      private List<ObjectId> deepenNots
    • UNSHALLOW

      private final RevFlag UNSHALLOW
    • REINTERESTING

      private final RevFlag REINTERESTING
    • DEEPEN_NOT

      private final RevFlag DEEPEN_NOT
  • Constructor Details

    • RevWalk

      public RevWalk(Repository repo, int depth)
      Parameters:
      repo - Repository to walk
      depth - Maximum depth to return
    • RevWalk

      public RevWalk(ObjectReader or, int depth)
      Parameters:
      or - ObjectReader to use
      depth - Maximum depth to return
  • Method Details

    • markRoot

      Mark a root commit (i.e., one whose depth should be considered 0.)
      Parameters:
      c - Commit to mark
      Throws:
      IOException
      IncorrectObjectTypeException
      MissingObjectException
    • createCommit

      protected RevCommit createCommit(AnyObjectId id)
      Description copied from class: RevWalk
      Construct a new unparsed commit for the given object.
      Overrides:
      createCommit in class RevWalk
      Parameters:
      id - the object this walker requires a commit reference for.
      Returns:
      a new unparsed reference for the object.
    • getDepth

      public int getDepth()
      Description copied from interface: DepthWalk
      Get depth to filter to.
      Specified by:
      getDepth in interface DepthWalk
      Returns:
      Depth to filter to.
    • getDeepenSince

      public int getDeepenSince()
      Specified by:
      getDeepenSince in interface DepthWalk
      Returns:
      the deepen-since value; if not 0, this walk only returns commits whose commit time is at or after this limit
    • setDeepenSince

      public void setDeepenSince(int limit)
      Sets the deepen-since value.
      Parameters:
      limit - new deepen-since value
      Since:
      5.2
    • getDeepenNots

      public List<ObjectId> getDeepenNots()
      Specified by:
      getDeepenNots in interface DepthWalk
      Returns:
      the objects specified by the client using --shallow-exclude
    • setDeepenNots

      public void setDeepenNots(List<ObjectId> deepenNots)
      Mark objects that the client specified using --shallow-exclude. Objects that are not commits have no effect.
      Parameters:
      deepenNots - specified objects
      Since:
      5.2
    • getUnshallowFlag

      public RevFlag getUnshallowFlag()
      Description copied from interface: DepthWalk
      Get flag marking commits that should become unshallow.
      Specified by:
      getUnshallowFlag in interface DepthWalk
      Returns:
      flag marking commits that should become unshallow.
    • getReinterestingFlag

      public RevFlag getReinterestingFlag()
      Description copied from interface: DepthWalk
      Get flag marking commits that are interesting again.
      Specified by:
      getReinterestingFlag in interface DepthWalk
      Returns:
      flag marking commits that are interesting again.
    • getDeepenNotFlag

      public RevFlag getDeepenNotFlag()
      Specified by:
      getDeepenNotFlag in interface DepthWalk
      Returns:
      flag marking commits that are to be excluded because of --shallow-exclude
    • toObjectWalkWithSameObjects

      public DepthWalk.ObjectWalk toObjectWalkWithSameObjects()
      Description copied from class: RevWalk
      Create and return an ObjectWalk using the same objects.

      Prior to using this method, the caller must reset this RevWalk to clean any flags that were used during the last traversal.

      The returned ObjectWalk uses the same ObjectReader, internal object pool, and free RevFlags. Once the ObjectWalk is created, this RevWalk should not be used anymore.

      Overrides:
      toObjectWalkWithSameObjects in class RevWalk
      Returns:
      a new walk, using the exact same object pool.
      Since:
      4.5