com.jcabi.github

Interface Forks

@Immutable
public interface Forks

Github forks.

Since:

0.8

Version:

$Id$

Author:

Carlos Miranda (miranda.cma@gmail.com)

See Also:

Forks API

Method Summary

Methods

Modifier and Type	Method and Description
Fork	create(String organization) Create a fork for the authenticated user.
Iterable<Fork>	iterate(String sort) Iterate all forks.
Repo	repo() Owner of them.

Method Detail

repo

@NotNull(message="repository is never NULL")
Repo repo()

Owner of them.

Returns:

Repo

iterate

@NotNull(message="Iterable of forks is never NULL")
Iterable<Fork> iterate(@NotNull(message="Sort order can\'t be NULL")
                                    String sort)

Iterate all forks.

Parameters:

sort - The sort order.

Returns:

All forks

See Also:

List forks

create

@NotNull(message="Fork is never NULL")
Fork create(@NotNull(message="organization can\'t be NULL")
                         String organization)
            throws IOException

Create a fork for the authenticated user.

Parameters:

organization - The organization the repository will be forked into.

Returns:

The new fork

Throws:

IOException - If there is any I/O problem

See Also:

Create a fork