com.jcabi.github

Interface RepoCommits

All Superinterfaces:

JsonReadable

@Immutable
public interface RepoCommits
extends JsonReadable

Commits of a Github repository.

Version:

$Id$

Author:

Alexander Sinyagin (sinyagin.alexander@gmail.com)

See Also:

Commits API

Method Summary

Methods

Modifier and Type	Method and Description
CommitsComparison	compare(String base, String head) Compare two commits.
String	diff(String base, String head) Compare two commits and provide result in diff format.
RepoCommit	get(String sha) Get single repository's commits.
Iterable<RepoCommit>	iterate(Map<String,String> params) Iterate all repository's commits.
String	patch(String base, String head) Compare two commits and provide result in patch format.

Methods inherited from interface com.jcabi.github.JsonReadable

json

Method Detail

iterate

@NotNull(message="iterable is never NULL")
Iterable<RepoCommit> iterate(@NotNull(message="params can\'t be NULL")
                                          Map<String,String> params)

Iterate all repository's commits.

Parameters:

params - Url's parameters

Returns:

All commits

See Also:

List commits on a repository

get

@NotNull(message="RepoCommit is never NULL")
RepoCommit get(@NotNull(message="sha is never NULL")
                            String sha)

Get single repository's commits.

Parameters:

sha - SHA of a commit

Returns:

RepoCommit

See Also:

Get a single commit

compare

@NotNull(message="repo commits comparison is never NULL")
CommitsComparison compare(@NotNull(message="base is never NULL")
                                       String base,
                                       @NotNull(message="base is never NULL")
                                       String head)

Compare two commits.

Parameters:

base - SHA of the base repo commit

head - SHA of the head repo commit

Returns:

Commits comparison

diff

@NotNull(message="repo commits comparison is never NULL")
String diff(@NotNull(message="base is never NULL")
                         String base,
                         @NotNull(message="head is never NULL")
                         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

@NotNull(message="repo commits comparison is never NULL")
String patch(@NotNull(message="base is never NULL")
                          String base,
                          @NotNull(message="head is never NULL")
                          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