com.jcabi.github

Interface Search

@Immutable
public interface Search

Github search.

Since:

0.8

Version:

$Id$

Author:

Carlos Miranda (miranda.cma@gmail.com)

See Also:

Search API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Search.Order
static class	Search.Qualifier

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Content>	codes(String keywords, String sort, Search.Order order) Search code.
Github	github() Github we're in.
Iterable<Issue>	issues(String keywords, String sort, Search.Order order, EnumMap<Search.Qualifier,String> qualifiers) Search issues.
Iterable<Repo>	repos(String keywords, String sort, Search.Order order) Search repositories.
Iterable<User>	users(String keywords, String sort, Search.Order order) Search users.

Method Detail

github

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

Github we're in.

Returns:

Github

repos

@NotNull(message="Iterable of repos is never NULL")
Iterable<Repo> repos(@NotNull(message="Search keywords can\'t be NULL")
                                  String keywords,
                                  @NotNull(message="Sort field can\'t be NULL")
                                  String sort,
                                  @NotNull(message="Sort order can\'t be NULL")
                                  Search.Order order)
                     throws IOException

Search repositories.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

Returns:

Repos

Throws:

IOException - If there is any I/O problem

See Also:

Search repositories

issues

@NotNull(message="Iterable of issues is never NULL")
Iterable<Issue> issues(@NotNull(message="Search keywords can\'t be NULL")
                                    String keywords,
                                    @NotNull(message="Sort field can\'t be NULL")
                                    String sort,
                                    @NotNull(message="Sort order can\'t be NULL")
                                    Search.Order order,
                                    @NotNull(message="Search qualifiers can\'t be NULL")
                                    EnumMap<Search.Qualifier,String> qualifiers)
                       throws IOException

Search issues.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

qualifiers - The search qualifier

Returns:

Issues

Throws:

IOException - If there is any I/O problem

See Also:

Search issues

Suppressed Checkstyle violations:

ParameterNumberCheck (7 lines)

users

@NotNull(message="Iterable of users is never NULL")
Iterable<User> users(@NotNull(message="Search keywords can\'t be NULL")
                                  String keywords,
                                  @NotNull(message="Sort field can\'t be NULL")
                                  String sort,
                                  @NotNull(message="Sort order can\'t be NULL")
                                  Search.Order order)
                     throws IOException

Search users.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

Returns:

Users

Throws:

IOException - If there is any I/O problem

See Also:

Search users

codes

@NotNull(message="Iterable of users is never NULL")
Iterable<Content> codes(@NotNull(message="Search keywords can\'t be NULL")
                                     String keywords,
                                     @NotNull(message="Sort field can\'t be NULL")
                                     String sort,
                                     @NotNull(message="Sort order can\'t be NULL")
                                     Search.Order order)
                        throws IOException

Search code.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

Returns:

Contents

Throws:

IOException - If there is any I/O problem

See Also:

Search code