Package com.jcabi.github

Object Oriented Github API.

See: Description

Interface Summary

Interface	Description
Assignees	Github Assignees.
Blob	Github Git blob.
Blobs	Github Git Data Blobs.
Collaborators	Github repository collaborators.
Comment	Github issue comment.
Comments	Github comments.
Commit	Github commit.
Commits	Github Git Data Commits.
CommitsComparison	Commits comparison.
Content	Github content.
Contents	Github contents.
Coordinates	Repository coordinates.
DeployKey	Github deploy key.
DeployKeys	Github deploy keys.
Event	Github event.
Fork	Github fork.
Forks	Github forks.
Gist	Github gist.
GistComment	Gist comment.
GistComments	Gist Comments.
Gists	Github gists.
Git	Github Git.
Github	Github client, starting point to the entire library.
Gitignores	Github Gitignore.
Hook	Github hook.
Hooks	Github hooks.
Issue	Github issue.
IssueLabels	Github labels of an issue.
Issues	Github issues.
JsonPatchable	JSON patchable.
JsonReadable	JSON readable.
Label	Github label.
Labels	Github labels.
Limit	Github Rate Limit API, one resource limit.
Limits	Github Rate Limit API.
Markdown	Markdown API.
Milestone	Github Milestone.
Milestones	Github Milestones.
Notifications	Github Notifications API.
Organization	Github organization.
Organizations	Github organizations.
PublicKey	Github public key.
PublicKeys	Github public keys.
Pull	Github pull request.
PullComment	Github pull comment.
PullComments	Github pull comments.
Pulls	Github pull requests.
Reference	Github Git Data Reference.
References	Github Git Data References.
Release	Github release.
ReleaseAsset	Github release asset.
ReleaseAssets	Github release assets.
Releases	Github Releases.
Repo	Github repository.
RepoCommit	Github repo commit.
RepoCommits	Commits of a Github repository.
Repos	Github Repo API.
RtValuePagination.Mapping<X,P extends javax.json.JsonValue>	Mapping from JsonValue successor to the destination type.
Search	Github search.
Stars	Github starring API.
Tag	Github Git Data Tag.
Tags	Github Git Data Tags.
Tree	Github tree.
Trees	Github Git Data Trees.
User	Github user.
UserEmails	Github user's emails.
Users	Github users.

Class Summary

Class	Description
Blob.Smart	Smart Blob with extra features.
Bulk<T extends JsonReadable>	Bulk items, with pre-saved JSON.
Comment.Smart	Smart comment with additional features.
Commit.Smart	Smart commit.
CommitsComparison.Smart	Smart commits comparison with extra features.
Content.Smart	Smart Content with extra features.
Coordinates.Simple	Jcabi.http implementation.
DeployKey.Smart	Smart DeployKey with extra features.
Event.Smart	Smart event with extra features.
Fork.Smart	Smart Fork with extra features.
Gist.Smart	Smart Gist with extra features.
GistComment.Smart	Smart comment with additional features.
Github.Time	Time in Github JSON.
Hook.Smart	Smart Hook with extra features.
Issue.Smart	Smart Issue with extra features.
IssueLabels.Smart	Smart IssueLabels with extra features.
Label.Smart	Smart Label with extra features.
Label.Unmodified	Unmodified Label with extra features.
Labels.Smart	Smart Labels with extra features.
Limit.Smart	Smart limits with extra features.
Limit.Throttled	Throttled Limit.
Limits.Throttled	Throttled Limits.
Milestone.Smart	Smart Milestone with extra features.
Organization.Smart	Smart Organization with extra features.
PublicKey.Smart	Smart PublicKey with extra features.
Pull.Smart	Smart pull request with extra features.
PullComment.Smart	Smart PullComment with extra features.
Release.Smart	Smart release.
ReleaseAsset.Smart	Smart ReleaseAsset with extra features.
Repo.Smart	Smart Repo with extra features.
RepoCommit.Smart	Smart commit.
RtCommits	Github Commits.
RtGithub	Github client, starting point to the entire library.
RtNotifications	Github Notifications API.
RtPagination<T>	Github pagination.
RtStars	Github starring API.
RtValuePagination<T,P extends javax.json.JsonValue>	Github value pagination.
Smarts<T>	Smart items.
User.Smart	Smart user with extra features.

Enum Summary

Enum	Description
Search.Order
Search.Qualifier

Package com.jcabi.github Description

Object Oriented Github API.

The only dependency you need is (check our latest version available at github.jcabi.com):

<depedency>
   <groupId>com.jcabi</groupId>
   <artifactId>jcabi-github</artifactId>
 </dependency>

There are some design conventions in this library, which is important to keep in mind.

Sometimes we use JsonObject as an input argument for a method (for example, in Repos#create(JsonObject)), somewhere else we use Map (see Issues#iterate(Map)), in other case we use just a few plain Java types (see DeployKeys#create(String,String)), and sometimes we combine them (see Hooks#create(String,Map)). This is not a bug, it's done intentionally. The logic is simple. Class JsonObject is used when Github API is expecting a JSON object as HTTP request body. Map is used when Github API expects HTTP query parameters, and some of them are optional, and there are more than two of them. In all other situations we're using plain Java types.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

project website