com.jcabi.github.mock

Class MkCommit

java.lang.Object

com.jcabi.github.mock.MkCommit

All Implemented Interfaces:

Commit, JsonReadable, Comparable<Commit>

@Immutable
@Loggable(value=1)
public final class MkCommit
extends Object
implements Commit

Mock of Github Commit.

Version:

$Id$

Author:

Ed Hillmann (edhillmann@yahoo.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Commit

Commit.Smart

Constructor Summary

Constructors

Constructor and Description
MkCommit(MkStorage strg, String login, Coordinates crds, String commitsha) Public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Commit commit)
javax.json.JsonObject	json() Describe it in a JSON object.
Repo	repo() The repo we're in.
String	sha() SHA of it.

Methods inherited from class java.lang.Object

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

Constructor Detail

MkCommit

public MkCommit(@NotNull(message="strg can\'t be NULL")
        MkStorage strg,
        @NotNull(message="login can\'t be NULL")
        String login,
        @NotNull(message="crds can\'t be NULL")
        Coordinates crds,
        @NotNull(message="identifier can\'t be NULL")
        String commitsha)

Public constructor.

Parameters:

strg - The storage.

login - The login name

crds - Credential

commitsha - Commit's sha.

Suppressed Checkstyle violations:

ParameterNumber (5 lines)

Method Detail

repo

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

Description copied from interface: Commit

The repo we're in.

Specified by:

repo in interface Commit

Returns:

Repo

sha

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

Description copied from interface: Commit

SHA of it.

Specified by:

sha in interface Commit

Returns:

SHA

json

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject json()
                           throws IOException

Description copied from interface: JsonReadable

Describe it in a JSON object.

Specified by:

json in interface JsonReadable

Returns:

JSON object

Throws:

IOException - If there is any I/O problem

compareTo

public int compareTo(Commit commit)

Specified by:

compareTo in interface Comparable<Commit>