com.jcabi.github

Interface Gist

All Superinterfaces:

JsonPatchable, JsonReadable

All Known Implementing Classes:

Gist.Smart

@Immutable
public interface Gist
extends JsonReadable, JsonPatchable

Github gist.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Gists API

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
GistComments	comments() Get all comments of the gist.
Gist	fork() Fork the gist.
Github	github() Github we're in.
String	identifier() Get gist identifier.
String	read(String name) Read file content.
void	star() Star a gist.
boolean	starred() Checks if Gist is starred.
void	unstar() Unstar a gist.
void	write(String name, String content) Write file content.

Methods inherited from interface com.jcabi.github.JsonReadable

json

Methods inherited from interface com.jcabi.github.JsonPatchable

patch

Method Detail

github

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

Github we're in.

Returns:

Github

identifier

@NotNull(message="Identifier is never NULL")
String identifier()

Get gist identifier.

Returns:

Gist identifier

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

star

void star()
          throws IOException

Star a gist.

Throws:

IOException - If there is any I/O problem

unstar

void unstar()
            throws IOException

Unstar a gist.

Throws:

IOException - If there is any I/O problem

starred

boolean starred()
                throws IOException

Checks if Gist is starred.

Returns:

True if gist is starred

Throws:

IOException - If there is any I/O problem

fork

@NotNull(message="gist is never NULL")
Gist fork()
          throws IOException

Fork the gist.

Returns:

Forked gist

Throws:

IOException - If there is any I/O problem

comments

@NotNull(message="comments are never NULL")
GistComments comments()
                      throws IOException

Get all comments of the gist.

Returns:

GistComments

Throws:

IOException - If there is any I/O problem

See Also:

Gist Comments API