com.jcabi.github

Class Repo.Smart

java.lang.Object

com.jcabi.github.Repo.Smart

All Implemented Interfaces:

JsonPatchable, JsonReadable, Repo, Comparable<Repo>

Enclosing interface:

Repo

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

Smart Repo with extra features.

Nested Class Summary

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

Repo.Smart

Constructor Summary

Constructors

Constructor and Description
Repo.Smart(Repo rep) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Assignees	assignees() Get all available assignees to which issues may be assigned.
Collaborators	collaborators() Gel all collaborators.
RepoCommits	commits() Get repository's commits.
int	compareTo(Repo repos)
Contents	contents() Get all contents of the repo.
Coordinates	coordinates() Get its coordinates.
String	description() Get its description.
Iterable<Event>	events() Get all events for the repository.
Forks	forks() Get all forks of the repo.
Git	git() Get the Git API entry point.
Github	github() Get its owner.
Hooks	hooks() Hooks.
boolean	isPrivate() Is it private?.
Issues	issues() Iterate issues.
javax.json.JsonObject	json() Describe it in a JSON object.
DeployKeys	keys() Get all deploy keys of the repo.
Labels	labels() Get all labels of the repo.
Milestones	milestones() Iterate milestones.
Notifications	notifications() Get Notifications API.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
Pulls	pulls() Pull requests.
Releases	releases() Get all releases of the repo.
Stars	stars() Get Starring API.

Methods inherited from class java.lang.Object

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

Constructor Detail

Repo.Smart

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

Public ctor.

Parameters:

rep - Repo

Method Detail

description

@NotNull(message="description is never NULL")
public String description()
                   throws IOException

Get its description.

Returns:

Description

Throws:

IOException - If there is any I/O problem

isPrivate

public boolean isPrivate()
                  throws IOException

Is it private?.

Returns:

TRUE if it's private

Throws:

IOException - If there is any I/O problem

github

@NotNull(message="github is never NULL")
public Github github()

Description copied from interface: Repo

Get its owner.

Specified by:

github in interface Repo

Returns:

Github

coordinates

@NotNull(message="coordinates is never NULL")
public Coordinates coordinates()

Description copied from interface: Repo

Get its coordinates.

Specified by:

coordinates in interface Repo

Returns:

Coordinates

issues

@NotNull(message="issues is never NULL")
public Issues issues()

Description copied from interface: Repo

Iterate issues.

Specified by:

issues in interface Repo

Returns:

Issues

milestones

@NotNull(message="milestones is never NULL")
public Milestones milestones()

Description copied from interface: Repo

Iterate milestones.

Specified by:

milestones in interface Repo

Returns:

Milestones

pulls

@NotNull(message="pulls is never NULL")
public Pulls pulls()

Description copied from interface: Repo

Pull requests.

Specified by:

pulls in interface Repo

Returns:

Pulls

hooks

@NotNull(message="hooks is never NULL")
public Hooks hooks()

Description copied from interface: Repo

Hooks.

Specified by:

hooks in interface Repo

Returns:

Hooks

events

@NotNull(message="Iterable of events is never NULL")
public Iterable<Event> events()

Description copied from interface: Repo

Get all events for the repository.

Specified by:

events in interface Repo

Returns:

Events

See Also:

List Events for a Repository

labels

@NotNull(message="labels is never NULL")
public Labels labels()

Description copied from interface: Repo

Get all labels of the repo.

Specified by:

labels in interface Repo

Returns:

Labels

See Also:

Labels API

assignees

@NotNull(message="assignees is never NULL")
public Assignees assignees()

Description copied from interface: Repo

Get all available assignees to which issues may be assigned.

Specified by:

assignees in interface Repo

Returns:

Assignees

See Also:

Assignees API

releases

@NotNull(message="releases is never NULL")
public Releases releases()

Description copied from interface: Repo

Get all releases of the repo.

Specified by:

releases in interface Repo

Returns:

Releases

See Also:

Releases API

keys

@NotNull(message="keys is never NULL")
public DeployKeys keys()

Description copied from interface: Repo

Get all deploy keys of the repo.

Specified by:

keys in interface Repo

Returns:

DeployKeys

See Also:

Deploy Keys API

forks

@NotNull(message="forks is never NULL")
public Forks forks()

Description copied from interface: Repo

Get all forks of the repo.

Specified by:

forks in interface Repo

Returns:

Forks

See Also:

Forks API

contents

@NotNull(message="contents is never NULL")
public Contents contents()

Description copied from interface: Repo

Get all contents of the repo.

Specified by:

contents in interface Repo

Returns:

Contents

See Also:

Contents API

collaborators

@NotNull(message="collaborators is never NULL")
public Collaborators collaborators()

Description copied from interface: Repo

Gel all collaborators.

Specified by:

collaborators in interface Repo

Returns:

Collaborators

See Also:

Collaborators API

git

@NotNull(message="git is never NULL")
public Git git()

Description copied from interface: Repo

Get the Git API entry point.

Specified by:

git in interface Repo

Returns:

Collaborators

See Also:

Git Data API

stars

@NotNull(message="stars is never NULL")
public Stars stars()

Description copied from interface: Repo

Get Starring API.

Specified by:

stars in interface Repo

Returns:

Stars

See Also:

Starring API

notifications

@NotNull(message="notifications is never NULL")
public Notifications notifications()

Description copied from interface: Repo

Get Notifications API.

Specified by:

notifications in interface Repo

Returns:

Stars

See Also:

Notifications API

patch

public void patch(@NotNull(message="json can\'t be NULL")
         javax.json.JsonObject json)
           throws IOException

Description copied from interface: JsonPatchable

Patch using this JSON object.

Specified by:

patch in interface JsonPatchable

Parameters:

json - JSON object

Throws:

IOException - If there is any I/O problem

commits

@NotNull(message="commits is never NULL")
public RepoCommits commits()

Description copied from interface: Repo

Get repository's commits.

Specified by:

commits in interface Repo

Returns:

Commits

See Also:

Commits API

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(Repo repos)

Specified by:

compareTo in interface Comparable<Repo>