com.jcabi.github

Interface Commit

All Superinterfaces:

Comparable<Commit>, JsonReadable

All Known Implementing Classes:

Commit.Smart, MkCommit

@Immutable
public interface Commit
extends Comparable<Commit>, JsonReadable

Github commit.

The commit exposes all available properties through its json() method. However, it is recommended to use its "smart" decorator, which helps you to get access to all JSON properties, for example:

 URL url = new Commit.Smart(commit).url();

Since:

0.3

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Pull Request API, Commits API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Commit.Smart Smart commit.

Method Summary

Methods

Modifier and Type	Method and Description
Repo	repo() The repo we're in.
String	sha() SHA of it.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jcabi.github.JsonReadable

json

Method Detail

repo

@NotNull(message="repo is never NULL")
Repo repo()

The repo we're in.

Returns:

Repo

sha

@NotNull(message="commit SHA is never NULL")
String sha()

SHA of it.

Returns:

SHA