org.modeshape.connector.git

## Class GitHistory

- java.lang.Object
- - org.modeshape.connector.git.GitFunction
  - - org.modeshape.connector.git.GitHistory

- All Implemented Interfaces:
    PageableGitFunction

      public class GitHistory
      extends GitFunction
      implements PageableGitFunction

  A `GitFunction` that returns the history information about the (latest) commits in a particular branch or tag. The structure of this area of the repository is as follows:

         /commits/{branchOrTagNameOrObjectId}/{objectId}

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected static int` | `DEFAULT_PAGE_SIZE`
    `protected static String` | `ID`
    `protected static String` | `NAME`

    - ### Fields inherited from class org.modeshape.connector.git.GitFunction

      `connector, DELIMITER, name, REMOTE_BRANCH_PREFIX, REVERSE_REF_COMPARATOR, TAG_PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `GitHistory(GitConnector connector)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Document` | `execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `Document` | `execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, PageWriter writer, Values values, PageKey pageKey)`
    `boolean` | `isPaged()`
    `protected static Object` | `referenceToHistory(org.eclipse.jgit.lib.ObjectId id, String branchOrTagName, Values values)`

    - ### Methods inherited from class org.modeshape.connector.git.GitFunction

      `addBranchesAsChildren, addCommitsAsChildren, addCommitsAsPageOfChildren, addTagsAsChildren, authorName, branchRefForName, branchRefForName, commiterName, getName, isQueryable, resolveBranchOrTagOrCommitId, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### NAME

          protected static final String NAME

      See Also:
        Constant Field Values

    - #### ID

          protected static final String ID

      See Also:
        Constant Field Values

    - #### DEFAULT_PAGE_SIZE

          protected static int DEFAULT_PAGE_SIZE

  - ### Constructor Detail

    - #### GitHistory

          public GitHistory(GitConnector connector)

  - ### Method Detail

    - #### referenceToHistory

          protected static Object referenceToHistory(org.eclipse.jgit.lib.ObjectId id,
                                  String branchOrTagName,
                                  Values values)

    - #### isPaged

          public boolean isPaged()

      Overrides:
        `isPaged` in class `GitFunction`

    - #### execute

          public Document execute(org.eclipse.jgit.lib.Repository repository,
                         org.eclipse.jgit.api.Git git,
                         CallSpecification spec,
                         DocumentWriter writer,
                         Values values)
                           throws org.eclipse.jgit.api.errors.GitAPIException,
                                  IOException

      Specified by:
        `execute` in class `GitFunction`
      Throws:
        `org.eclipse.jgit.api.errors.GitAPIException`
        `IOException`

    - #### execute

          public Document execute(org.eclipse.jgit.lib.Repository repository,
                         org.eclipse.jgit.api.Git git,
                         CallSpecification spec,
                         PageWriter writer,
                         Values values,
                         PageKey pageKey)
                           throws org.eclipse.jgit.api.errors.GitAPIException,
                                  IOException

      Specified by:
        `execute` in interface `PageableGitFunction`
      Throws:
        `org.eclipse.jgit.api.errors.GitAPIException`
        `IOException`

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.