com.jcabi.github

Class Gist.Smart

java.lang.Object

com.jcabi.github.Gist.Smart

All Implemented Interfaces:

Gist, JsonPatchable, JsonReadable

Enclosing interface:

Gist

@Immutable
@Loggable(value=1)
public static final class Gist.Smart
extends Object
implements Gist

Smart Gist with extra features.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Gist

Gist.Smart

Constructor Summary

Constructors

Constructor and Description
Gist.Smart(Gist gst) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
GistComments	comments() Get all comments of the gist.
Iterable<String>	files() Get a list of all file names in the gist.
Gist	fork() Fork the gist.
Github	github() Github we're in.
String	identifier() Get gist id.
javax.json.JsonObject	json() Describe it in a JSON object.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
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 class java.lang.Object

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

Constructor Detail

Gist.Smart

public Gist.Smart(@NotNull(message="gst can\'t be NULL")
          Gist gst)

Public ctor.

Parameters:

gst - Gist

Method Detail

identifier

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

Get gist id.

Specified by:

identifier in interface Gist

Returns:

Gist id

files

@NotNull(message="Iterable of files is never NULL")
public Iterable<String> files()
                       throws IOException

Get a list of all file names in the gist.

Returns:

File names

Throws:

IOException - If there is any I/O problem

github

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

Description copied from interface: Gist

Github we're in.

Specified by:

github in interface Gist

Returns:

Github

read

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

Description copied from interface: Gist

Read file content.

Specified by:

read in interface Gist

Parameters:

name - Name of it

Returns:

File content

Throws:

IOException - If there is any I/O problem

See Also:

Get a Single Gist

write

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

Description copied from interface: Gist

Write file content.

Specified by:

write in interface Gist

Parameters:

name - Name of it

content - Content to write

Throws:

IOException - If there is any I/O problem

See Also:

Edit a Gist

star

public void star()
          throws IOException

Description copied from interface: Gist

Star a gist.

Specified by:

star in interface Gist

Throws:

IOException - If there is any I/O problem

unstar

public void unstar()
            throws IOException

Description copied from interface: Gist

Unstar a gist.

Specified by:

unstar in interface Gist

Throws:

IOException - If there is any I/O problem

starred

public boolean starred()
                throws IOException

Description copied from interface: Gist

Checks if Gist is starred.

Specified by:

starred in interface Gist

Returns:

True if gist is starred

Throws:

IOException - If there is any I/O problem

fork

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

Description copied from interface: Gist

Fork the gist.

Specified by:

fork in interface Gist

Returns:

Forked gist

Throws:

IOException - If there is any I/O problem

comments

@NotNull(message="gist comments is never NULL")
public GistComments comments()
                      throws IOException

Description copied from interface: Gist

Get all comments of the gist.

Specified by:

comments in interface Gist

Returns:

GistComments

Throws:

IOException - If there is any I/O problem

See Also:

Gist Comments API

json

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject json()
                           throws IOException

Description copied from interface: JsonReadable

Describe it in a JSON object.

Specified by:

json in interface JsonReadable

Returns:

JSON object

Throws:

IOException - If there is any I/O problem

patch

public void patch(@NotNull(message="json can\'t be NULL")
         javax.json.JsonObject json)
           throws IOException

Description copied from interface: JsonPatchable

Patch using this JSON object.

Specified by:

patch in interface JsonPatchable

Parameters:

json - JSON object

Throws:

IOException - If there is any I/O problem