Interface RepoCommits

  • All Superinterfaces:
    JsonReadable

    @Immutable
    public interface RepoCommits
    extends JsonReadable
    Commits of a Github repository.
    Version:
    $Id: 438236f31669686c1eb4e860584d58b0d04284f4 $
    Author:
    Alexander Sinyagin (sinyagin.alexander@gmail.com)
    See Also:
    Commits API
    • Method Detail

      • compare

        CommitsComparison compare​(String base,
                                  String head)
        Compare two commits.
        Parameters:
        base - SHA of the base repo commit
        head - SHA of the head repo commit
        Returns:
        Commits comparison
      • diff

        String diff​(String base,
                    String head)
             throws IOException
        Compare two commits and provide result in diff format.
        Parameters:
        base - SHA of the base repo commit
        head - SHA of the head repo commit
        Returns:
        Commits comparison
        Throws:
        IOException - If there is any I/O problem
        Since:
        0.8
      • patch

        String patch​(String base,
                     String head)
              throws IOException
        Compare two commits and provide result in patch format.
        Parameters:
        base - SHA of the base repo commit
        head - SHA of the head repo commit
        Returns:
        Commits comparison
        Throws:
        IOException - If there is any I/O problem
        Since:
        0.8