Package com.jcabi.github

Interface RepoCommits

All Superinterfaces:

JsonReadable

@Immutable
public interface RepoCommits
extends JsonReadable

Commits of a GitHub repository.

Since:

0.3

See Also:

• Commits API

Method Summary

Modifier and Type	Method	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 Details

iterate

Iterable<RepoCommit> iterate(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

RepoCommit get(String sha)

Get single repository's commits.

Parameters:

sha - SHA of a commit

Returns:

RepoCommit

See Also:

• Get a single commit

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