com.jcabi.github

Interface Contents

@Immutable
public interface Contents

Github contents.

Since:

0.8

Version:

$Id$

Author:

Andres Candal (andres.candal@rollasolution.com)

See Also:

Contents API

Suppressed Checkstyle violations:

MultipleStringLiteralsCheck (500 lines)

Method Summary

Methods

Modifier and Type	Method and Description
Content	create(javax.json.JsonObject content) Create new file.
boolean	exists(String path, String ref) Check whether content exists or not.
Content	get(String path) Get the contents of a file or symbolic link in a repository's default branch (usually master).
Content	get(String path, String ref) Get the contents of a file or symbolic link in a repository.
Iterable<Content>	iterate(String path, String ref) Get the contents of a directory in a repository.
Content	readme() Get the Readme file of the default branch (usually master).
Content	readme(String branch) Get the Readme file of the specified branch.
RepoCommit	remove(javax.json.JsonObject content) Removes a file.
Repo	repo() Owner of them.
RepoCommit	update(String path, javax.json.JsonObject json) Updates a file.

Method Detail

repo

@NotNull(message="repository is never NULL")
Repo repo()

Owner of them.

Returns:

Repo

readme

@NotNull(message="Content is never NULL")
Content readme()
               throws IOException

Get the Readme file of the default branch (usually master).

Returns:

The Content of the readme file.

Throws:

IOException - If an IO Exception occurs.

See Also:

Get the README

readme

@NotNull(message="Content is never NULL")
Content readme(@NotNull(message="branch is never NULL")
                            String branch)
               throws IOException

Get the Readme file of the specified branch.

Parameters:

branch - The branch name

Returns:

The Content of the readme file.

Throws:

IOException - If an IO Exception occurs.

See Also:

Get the README

create

@NotNull(message="Content is never NULL")
Content create(@NotNull(message="content is never NULL")
                            javax.json.JsonObject content)
               throws IOException

Create new file.

Parameters:

content - Parameters to create new content

Returns:

Content just created

Throws:

IOException - If there is any I/O problem

See Also:

Create a file

get

@NotNull(message="Content is never NULL")
Content get(@NotNull(message="path  is never NULL")
                         String path,
                         @NotNull(message="ref is never NULL")
                         String ref)
            throws IOException

Get the contents of a file or symbolic link in a repository.

Parameters:

path - The content path

ref - The name of the commit/branch/tag.

Returns:

Content fetched

Throws:

IOException - If there is any I/O problem

See Also:

Get contents

get

@NotNull(message="Content is never NULL")
Content get(@NotNull(message="path  is never NULL")
                         String path)
            throws IOException

Get the contents of a file or symbolic link in a repository's default branch (usually master).

Parameters:

path - The content path

Returns:

Content fetched

Throws:

IOException - If there is any I/O problem

See Also:

Get contents

iterate

@NotNull(message="iterable is never NULL")
Iterable<Content> iterate(@NotNull(message="path  is never NULL")
                                       String path,
                                       @NotNull(message="ref is never NULL")
                                       String ref)
                          throws IOException

Get the contents of a directory in a repository.

Parameters:

path - The content path

ref - The name of the commit/branch/tag. Default: the repository's default branch (usually master)

Returns:

Contents fetched

Throws:

IOException - If there is any I/O problem

See Also:

Get contents

remove

@NotNull(message="Content is never NULL")
RepoCommit remove(@NotNull(message="content is never NULL")
                               javax.json.JsonObject content)
                  throws IOException

Removes a file.

Parameters:

content - Parameters to remove a file

Returns:

RepoCommit referring to this operation

Throws:

IOException - If there is any I/O problem

See Also:

Delete a file

update

@NotNull(message="RepoCommit is never NULL")
RepoCommit update(@NotNull(message="path is never NULL")
                               String path,
                               @NotNull(message="json is never NULL")
                               javax.json.JsonObject json)
                  throws IOException

Updates a file.

Parameters:

path - The content path.

json - JSON object containing updates to the content.

Returns:

Commit referring to this operation

Throws:

IOException - If any I/O problems occur.

See Also:

Update a file

exists

boolean exists(@NotNull(message="path  is never NULL")
             String path,
             @NotNull(message="ref is never NULL")
             String ref)
               throws IOException

Check whether content exists or not.

Parameters:

path - The content path

ref - The name of the commit/branch/tag.

Returns:

True if content exists, false otherwise.

Throws:

IOException - If there is any I/O problem