com.jdroid.github.service

Class ContentsService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.ContentsService

public class ContentsService
extends GitHubService

Service for accessing repository contents

See Also:

GitHub contents API documentation

Field Summary

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
ContentsService() Create contents service
ContentsService(GitHubClient client) Create contents service

Method Summary

Modifier and Type	Method and Description
java.util.List<RepositoryContents>	getContents(IRepositoryIdProvider repository) Get contents at the root of the given repository on master branch
java.util.List<RepositoryContents>	getContents(IRepositoryIdProvider repository, java.lang.String path) Get contents at path in the given repository on master branch
java.util.List<RepositoryContents>	getContents(IRepositoryIdProvider repository, java.lang.String path, java.lang.String ref) Get contents of path at reference in given repository
RepositoryContents	getReadme(IRepositoryIdProvider repository) Get repository README
RepositoryContents	getReadme(IRepositoryIdProvider repository, java.lang.String ref) Get repository README

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentsService

public ContentsService()

Create contents service

ContentsService

public ContentsService(GitHubClient client)

Create contents service

Parameters:

client -

Method Detail

getReadme

public RepositoryContents getReadme(IRepositoryIdProvider repository)
                             throws java.lang.Exception

Get repository README

Parameters:

repository -

Returns:

README

Throws:

java.lang.Exception

getReadme

public RepositoryContents getReadme(IRepositoryIdProvider repository,
                                    java.lang.String ref)
                             throws java.io.IOException

Get repository README

Parameters:

repository -

ref -

Returns:

README

Throws:

java.io.IOException

getContents

public java.util.List<RepositoryContents> getContents(IRepositoryIdProvider repository)
                                               throws java.io.IOException

Get contents at the root of the given repository on master branch

Parameters:

repository -

Returns:

list of contents at root

Throws:

java.io.IOException

getContents

public java.util.List<RepositoryContents> getContents(IRepositoryIdProvider repository,
                                                      java.lang.String path)
                                               throws java.io.IOException

Get contents at path in the given repository on master branch

Parameters:

repository -

path -

Returns:

list of contents at path

Throws:

java.io.IOException

getContents

public java.util.List<RepositoryContents> getContents(IRepositoryIdProvider repository,
                                                      java.lang.String path,
                                                      java.lang.String ref)
                                               throws java.io.IOException

Get contents of path at reference in given repository

For file paths this will return a list with one entry corresponding to the file contents at the given path

Parameters:

repository -

path -

ref -

Returns:

list of contents at path

Throws:

java.io.IOException