org.kohsuke.github

Class GHContent

java.lang.Object

org.kohsuke.github.GHContent

public class GHContent
extends Object

A Content of a repository.

Author:

Alexandre COLLIGNON

See Also:

GHRepository.getFileContent(String)

Constructor Summary

Constructors

Constructor and Description
GHContent()

Method Summary

Methods

Modifier and Type	Method and Description
GHContentUpdateResponse	delete(String message)
GHContentUpdateResponse	delete(String commitMessage, String branch)
String	getContent() Deprecated. Use read()
String	getDownloadUrl() URL to retrieve the raw content of the file.
String	getEncodedContent() Deprecated. Use read()
String	getEncoding()
String	getGitUrl()
String	getHtmlUrl()
String	getName()
GHRepository	getOwner()
String	getPath()
String	getSha()
long	getSize()
String	getType()
String	getUrl()
boolean	isDirectory()
boolean	isFile()
PagedIterable<GHContent>	listDirectoryContent() List immediate children of this directory.
protected void	populate() Fully populate the data by retrieving missing data.
InputStream	read() Retrieves the actual content stored here.
GHContentUpdateResponse	update(byte[] newContentBytes, String commitMessage)
GHContentUpdateResponse	update(byte[] newContentBytes, String commitMessage, String branch)
GHContentUpdateResponse	update(String newContent, String commitMessage)
GHContentUpdateResponse	update(String newContent, String commitMessage, String branch)
static GHContent[]	wrap(GHContent[] contents, GHRepository repository)

Methods inherited from class java.lang.Object

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

Constructor Detail

GHContent

public GHContent()

Method Detail

getOwner

public GHRepository getOwner()

getType

public String getType()

getEncoding

public String getEncoding()

getSize

public long getSize()

getSha

public String getSha()

getName

public String getName()

getPath

public String getPath()

getContent

public String getContent()
                  throws IOException

Deprecated. Use read()

Retrieve the decoded content that is stored at this location.

Due to the nature of GitHub's API, you're not guaranteed that the content will already be populated, so this may trigger network activity, and can throw an IOException.

Throws:

IOException

getEncodedContent

public String getEncodedContent()
                         throws IOException

Deprecated. Use read()

Retrieve the base64-encoded content that is stored at this location.

Due to the nature of GitHub's API, you're not guaranteed that the content will already be populated, so this may trigger network activity, and can throw an IOException.

Throws:

IOException

getUrl

public String getUrl()

getGitUrl

public String getGitUrl()

getHtmlUrl

public String getHtmlUrl()

read

public InputStream read()
                 throws IOException

Retrieves the actual content stored here.

Throws:

IOException

getDownloadUrl

public String getDownloadUrl()
                      throws IOException

URL to retrieve the raw content of the file. Null if this is a directory.

Throws:

IOException

isFile

public boolean isFile()

isDirectory

public boolean isDirectory()

populate

protected void populate()
                 throws IOException

Fully populate the data by retrieving missing data. Depending on the original API call where this object is created, it may not contain everything.

Throws:

IOException

listDirectoryContent

public PagedIterable<GHContent> listDirectoryContent()
                                              throws IOException

List immediate children of this directory.

Throws:

IOException

update

public GHContentUpdateResponse update(String newContent,
                             String commitMessage)
                               throws IOException

Throws:

IOException

update

public GHContentUpdateResponse update(String newContent,
                             String commitMessage,
                             String branch)
                               throws IOException

Throws:

IOException

update

public GHContentUpdateResponse update(byte[] newContentBytes,
                             String commitMessage)
                               throws IOException

Throws:

IOException

update

public GHContentUpdateResponse update(byte[] newContentBytes,
                             String commitMessage,
                             String branch)
                               throws IOException

Throws:

IOException

delete

public GHContentUpdateResponse delete(String message)
                               throws IOException

Throws:

IOException

delete

public GHContentUpdateResponse delete(String commitMessage,
                             String branch)
                               throws IOException

Throws:

IOException

wrap

public static GHContent[] wrap(GHContent[] contents,
               GHRepository repository)