org.kohsuke.github

Class GHGist

java.lang.Object

org.kohsuke.github.GHGist

public final class GHGist
extends Object

Gist

Author:

Kohsuke Kawaguchi

See Also:

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

Constructor Summary

Constructors

Constructor and Description
GHGist()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Deletes this gist.
boolean	equals(Object o)
GHGist	fork() Forks this gist into your own.
int	getCommentCount()
String	getCommentsUrl() API URL of listing comments.
String	getCommitsUrl()
Date	getCreatedAt()
String	getDescription()
GHGistFile	getFile(String name)
Map<String,GHGistFile>	getFiles()
String	getForksUrl()
String	getGitPullUrl() URL like https://gist.github.com/gists/12345.git
String	getGitPushUrl()
String	getHtmlUrl()
String	getId() ID of this gist, such as '12345'
GHUser	getOwner() User that owns this Gist.
Date	getUpdatedAt()
String	getUrl() API URL of this gist, such as 'https://api.github.com/gists/12345'
int	hashCode()
boolean	isPublic()
boolean	isStarred()
PagedIterable<GHGist>	listForks()
void	star()
void	unstar()

Methods inherited from class java.lang.Object

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

Constructor Detail

GHGist

public GHGist()

Method Detail

getOwner

public GHUser getOwner()

User that owns this Gist.

getUrl

public String getUrl()

API URL of this gist, such as 'https://api.github.com/gists/12345'

getForksUrl

public String getForksUrl()

getCommitsUrl

public String getCommitsUrl()

getId

public String getId()

ID of this gist, such as '12345'

getGitPullUrl

public String getGitPullUrl()

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

getGitPushUrl

public String getGitPushUrl()

getHtmlUrl

public String getHtmlUrl()

isPublic

public boolean isPublic()

getCreatedAt

public Date getCreatedAt()

getUpdatedAt

public Date getUpdatedAt()

getDescription

public String getDescription()

getCommentCount

public int getCommentCount()

getCommentsUrl

public String getCommentsUrl()

API URL of listing comments.

getFile

public GHGistFile getFile(String name)

getFiles

public Map<String,GHGistFile> getFiles()

star

public void star()
          throws IOException

Throws:

IOException

unstar

public void unstar()
            throws IOException

Throws:

IOException

isStarred

public boolean isStarred()
                  throws IOException

Throws:

IOException

fork

public GHGist fork()
            throws IOException

Forks this gist into your own.

Throws:

IOException

listForks

public PagedIterable<GHGist> listForks()

delete

public void delete()
            throws IOException

Deletes this gist.

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object