com.jcabi.github

Interface Gists

@Immutable
public interface Gists

Github gists.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Gists API

Method Summary

Methods

Modifier and Type	Method and 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

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

Github we're in.

Returns:

Github

create

@NotNull(message="gist is never NULL")
Gist create(@NotNull(message="list of files can\'t be NULL")
                         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

@NotNull(message="gist is never NULL")
Gist get(@NotNull(message="name can\'t be NULL")
                      String name)

Get gist by name.

Parameters:

name - Name of it

Returns:

Gist

See Also:

Get a Single Gist

iterate

@NotNull(message="iterable is never NULL")
Iterable<Gist> iterate()

Iterate all gists.

Returns:

Iterator of gists

See Also:

List Gists

remove

void remove(@NotNull(message="identifier is never NULL")
          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