com.jcabi.github

Interface Organizations

@Immutable
public interface Organizations

Github organizations.

Since:

0.7

Version:

$Id$

Author:

Paul Polishchuk (ppol@ua.fm)

See Also:

Organizations API

Method Summary

Methods

Modifier and Type	Method and Description
Organization	get(String login) Get specific organization by name.
Github	github() Github we're in.
Iterable<Organization>	iterate() Iterate them all.
Iterable<Organization>	iterate(String username) Iterate organizations of particular user.
User	user() Get its owner.

Method Detail

github

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

Github we're in.

Returns:

Github

user

@NotNull(message="user is never NULL")
User user()

Get its owner.

Returns:

User

get

@NotNull(message="organization is never NULL")
Organization get(@NotNull(message="login is never NULL")
                              String login)

Get specific organization by name.

Parameters:

login - Login name of the organization.

Returns:

Organization

See Also:

Get a Single Organization

iterate

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

Iterate them all.

Returns:

Iterator of Organizations

See Also:

List Organizations

iterate

@NotNull(message="iterable is never NULL")
Iterable<Organization> iterate(@NotNull(message="username is never NULL")
                                            String username)

Iterate organizations of particular user. All public organizations for an unauthenticated user or private and public organizations for authenticated users

Parameters:

username - Name of user

Returns:

Iterator of Organizations

Since:

0.8

See Also:

List Organizations