com.jcabi.github

Interface Gist

All Superinterfaces:

JsonReadable

All Known Implementing Classes:

Gist.Smart

@Immutable
public interface Gist
extends JsonReadable

Github gist.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Gists API

To do:

#1:1hr New method star() and starred() for a single gist. Let's add these methods as explained in http://developer.github.com/v3/gists/ The method should be tested by integration and unit tests, and implemented in MkGist as well. When done, remove this comment., #1:1hr New method fork() to fork a gist. Let's introduce a new method, as explained in http://developer.github.com/v3/gists/#fork-a-gist. The method should be tested in a unit and integration tests. When done, remove this comment., #1:1hr Gist comments. Let's add new method comments() to this interface, returning an instance of interface GistComments. This new interface should implement methods do iterate, post, delete and read comments, as explained in http://developer.github.com/v3/gists/comments/. New interface should be implemented by GhGistComments class and tested with unit and integration tests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Gist.Smart Smart Gist with extra features.

Method Summary

Methods

Modifier and Type	Method and Description
Github	github() Github we're in.
String	read(String name) Read file content.
void	write(String name, String content) Write file content.

Methods inherited from interface com.jcabi.github.JsonReadable

json

Method Detail

github

@NotNull(message="Github is never NULL")
Github github()

Github we're in.

Returns:

Github

read

@NotNull(message="file content is never NULL")
String read(@NotNull(message="file name can\'t be NULL")
                         String name)
            throws IOException

Read file content.

Parameters:

name - Name of it

Returns:

File content

Throws:

IOException - If there is any I/O problem

See Also:

Get a Single Gist

write

void write(@NotNull(message="file name can\'t be NULL")
         String name,
         @NotNull(message="file content can\'t be NULL")
         String content)
           throws IOException

Write file content.

Parameters:

name - Name of it

content - Content to write

Throws:

IOException - If there is any I/O problem

See Also:

Edit a Gist