Package com.jcabi.github

Interface Gists

@Immutable
public interface Gists

Github gists.

Since:

0.1

Version:

$Id: 439a608065052c222995591a184596cf10916552 $

Author:

Yegor Bugayenko (yegor256@gmail.com)

See Also:

Gists API

Method Summary

Modifier and Type	Method	Description
Gist	create(Map<String,String> files, boolean visible)	Create a new gist.
Gist	get(String name)	Get gist by name.
Github	github()	Github we're in.
Iterable<Gist>	iterate()	Iterate all gists.
void	remove(String identifier)	Removes a gist by id.

Method Detail

github

Github github()

Github we're in.

Returns:

Github

create

Gist create(Map<String,String> files,
            boolean visible)
     throws IOException

Create a new gist.

Parameters:

files - Names and content of files

visible - Indicates whether the gist is public

Returns:

Gist

Throws:

IOException - If there is any I/O problem

See Also:

Create a Gist

get

Gist get(String name)

Get gist by name.

Parameters:

name - Name of it

Returns:

Gist

See Also:

Get a Single Gist

iterate

Iterable<Gist> iterate()

Iterate all gists.

Returns:

Iterator of gists

See Also:

List Gists

remove

void remove(String identifier)
     throws IOException

Removes a gist by id.

Parameters:

identifier - Identifier of the gist to be removed.

Throws:

IOException - If there is any I/O problem