org.kohsuke.github

Class GHObject

java.lang.Object

org.kohsuke.github.GHObject

Direct Known Subclasses:

GHApp, GHAppInstallation, GHAsset, GHAuthorization, GHCheckRun, GHCommitComment, GHCommitStatus, GHDeployment, GHDeploymentStatus, GHGist, GHHook, GHInvitation, GHIssue, GHIssueComment, GHLicense, GHMilestone, GHPerson, GHProject, GHProjectCard, GHProjectColumn, GHPullRequestReview, GHPullRequestReviewComment, GHReaction, GHRelease, GHRepository, GHRepositoryStatistics.CommitActivity, GHRepositoryStatistics.ContributorStats, GHRepositoryStatistics.Participation, GHRequestedAction, GHThread

public abstract class GHObject
extends Object

Most (all?) domain objects in GitHub seems to have these 4 properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	created_at
protected long	id
protected Map<String,List<String>>	responseHeaderFields Capture response HTTP headers on the state object.
protected String	updated_at
protected String	url

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt() When was this resource created?
abstract URL	getHtmlUrl() Gets html url.
long	getId() Gets id.
Map<String,List<String>>	getResponseHeaderFields() Deprecated.
Date	getUpdatedAt() When was this resource last updated?
URL	getUrl() Gets url.
String	toString() String representation to assist debugging and inspection.

Methods inherited from class java.lang.Object

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

Field Detail

responseHeaderFields

protected Map<String,List<String>> responseHeaderFields

Capture response HTTP headers on the state object.

url

protected String url

id

protected long id

created_at

protected String created_at

updated_at

protected String updated_at

Method Detail

getResponseHeaderFields

@CheckForNull
 @Deprecated
public Map<String,List<String>> getResponseHeaderFields()

Deprecated.

Returns the HTTP response headers given along with the state of this object.

Some of the HTTP headers have nothing to do with the object, for example "Cache-Control" and others are different depending on how this object was retrieved.

This method was added as a kind of hack to allow the caller to retrieve OAuth scopes and such. Use with caution. The method might be removed in the future.

Returns:

a map of header names to value lists

getCreatedAt

@WithBridgeMethods(value=java.lang.String.class,
                   adapterMethod="createdAtStr")
public Date getCreatedAt()
                                                                                                                    throws IOException

When was this resource created?

Returns:

date created

Throws:

IOException - on error

getUrl

@WithBridgeMethods(value=java.lang.String.class,
                   adapterMethod="urlToString")
public URL getUrl()

Gets url.

Returns:

API URL of this object.

getHtmlUrl

@WithBridgeMethods(value=java.lang.String.class,
                   adapterMethod="urlToString")
public abstract URL getHtmlUrl()
                                                                                                                         throws IOException

Gets html url.

Returns:

URL of this object for humans, which renders some HTML.

Throws:

IOException - on error

getUpdatedAt

public Date getUpdatedAt()
                  throws IOException

When was this resource last updated?

Returns:

updated date

Throws:

IOException - on error

getId

@WithBridgeMethods(value={java.lang.String.class,int.class},
                   adapterMethod="longToStringOrInt")
public long getId()

Gets id.

Returns:

Unique ID number of this resource.

toString

public String toString()

String representation to assist debugging and inspection. The output format of this string is not a committed part of the API and is subject to change.

Overrides:

toString in class Object