com.jcabi.github

Class Gist.Smart

java.lang.Object

com.jcabi.github.Gist.Smart

All Implemented Interfaces:

Gist, 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
Iterable<String>	files() Get a list of all file names in the gist.
Github	github() Github we're in.
javax.json.JsonObject	json() Describe it in a JSON object.
String	read(String name) Read file content.
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(Gist gst)

Public ctor.

Parameters:

gst - Gist

Method Detail

files

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

public Github github()

Description copied from interface: Gist

Github we're in.

Specified by:

github in interface Gist

Returns:

Github

read

public String read(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(String name,
         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

json

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