com.jcabi.github

Class CommitsComparison.Smart

java.lang.Object

com.jcabi.github.CommitsComparison.Smart

All Implemented Interfaces:

CommitsComparison, JsonReadable

Enclosing interface:

CommitsComparison

@Immutable
@Loggable(value=1)
public static final class CommitsComparison.Smart
extends Object
implements CommitsComparison

Smart commits comparison with extra features.

Nested Class Summary

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

CommitsComparison.Smart

Constructor Summary

Constructors

Constructor and Description
CommitsComparison.Smart(CommitsComparison cmprsn) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<RepoCommit>	commits() Get commits.
javax.json.JsonArray	files() Get a JSON-array of objects with information about files.
javax.json.JsonObject	json() Describe it in a JSON object.
Repo	repo() Get a parent repository of commits.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitsComparison.Smart

public CommitsComparison.Smart(@NotNull(message="cmprsn can\'t be NULL")
                       CommitsComparison cmprsn)

Public ctor.

Parameters:

cmprsn - Commits comparison

Method Detail

commits

@NotNull(message="Iterable of commits is never NULL")
public Iterable<RepoCommit> commits()
                             throws IOException

Get commits.

Returns:

Commits

Throws:

IOException - If there is any I/O problem

files

@NotNull(message="json array is never NULL")
public javax.json.JsonArray files()
                           throws IOException

Get a JSON-array of objects with information about files.

Returns:

JSON-array

Throws:

IOException - If there is any I/O problem

repo

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

Description copied from interface: CommitsComparison

Get a parent repository of commits.

Specified by:

repo in interface CommitsComparison

Returns:

Repository

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