org.kohsuke.github

Class GHGist

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHGist

public class GHGist
extends GHObject

Gist

Author:

Kohsuke Kawaguchi

See Also:

GHUser.listGists(), GitHub.getGist(String), GitHub.createGist(), documentation

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

created_at, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHGist()

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this gist.
boolean	equals(java.lang.Object o)
GHGist	fork() Forks this gist into your own.
int	getCommentCount()
java.lang.String	getCommentsUrl() API URL of listing comments.
java.lang.String	getCommitsUrl()
java.lang.String	getDescription()
GHGistFile	getFile(java.lang.String name)
java.util.Map<java.lang.String,GHGistFile>	getFiles()
java.lang.String	getForksUrl()
java.lang.String	getGitPullUrl() URL like https://gist.github.com/gists/12345.git
java.lang.String	getGitPushUrl()
java.net.URL	getHtmlUrl() URL of this object for humans, which renders some HTML.
GHUser	getOwner() User that owns this Gist.
int	hashCode()
boolean	isPublic()
boolean	isStarred()
PagedIterable<GHGist>	listForks()
void	star()
void	unstar()

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getUpdatedAt, getUrl, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GHGist

public GHGist()

Method Detail

getOwner

public GHUser getOwner()

User that owns this Gist.

getForksUrl

public java.lang.String getForksUrl()

getCommitsUrl

public java.lang.String getCommitsUrl()

getGitPullUrl

public java.lang.String getGitPullUrl()

URL like https://gist.github.com/gists/12345.git

getGitPushUrl

public java.lang.String getGitPushUrl()

getHtmlUrl

public java.net.URL getHtmlUrl()

Description copied from class: GHObject

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

Specified by:

getHtmlUrl in class GHObject

isPublic

public boolean isPublic()

getDescription

public java.lang.String getDescription()

getCommentCount

public int getCommentCount()

getCommentsUrl

public java.lang.String getCommentsUrl()

API URL of listing comments.

getFile

public GHGistFile getFile(java.lang.String name)

getFiles

public java.util.Map<java.lang.String,GHGistFile> getFiles()

star

public void star()
          throws java.io.IOException

Throws:

java.io.IOException

unstar

public void unstar()
            throws java.io.IOException

Throws:

java.io.IOException

isStarred

public boolean isStarred()
                  throws java.io.IOException

Throws:

java.io.IOException

fork

public GHGist fork()
            throws java.io.IOException

Forks this gist into your own.

Throws:

java.io.IOException

listForks

public PagedIterable<GHGist> listForks()

delete

public void delete()
            throws java.io.IOException

Deletes this gist.

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object