Package com.jcabi.github

Interface Search

@Immutable
public interface Search

Github search.

Since:

0.8

Version:

$Id: 06230f2b1f5cc95e03cc35ff751482fa82962b14 $

Author:

Carlos Miranda (miranda.cma@gmail.com)

See Also:

Search API

Nested Class Summary

Nested Classes

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

Method Summary

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

Github github()

Github we're in.

Returns:

Github

repos

Iterable<Repo> repos(String keywords,
                     String sort,
                     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

Iterable<Issue> issues(String keywords,
                       String sort,
                       Search.Order order,
                       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

Iterable<User> users(String keywords,
                     String sort,
                     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

Iterable<Content> codes(String keywords,
                        String sort,
                        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