Package com.jcabi.github

Interface Search

@Immutable
public interface Search

GitHub search.

Since:

0.8

See Also:

• Search API

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Search.Order
static enum	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 Details

github

GitHub github()

GitHub we're in.

Returns:

GitHub

repos

Iterable<Repo> repos(String keywords,
 String sort,
 Search.Order order)

Search repositories.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

Returns:

Repos

See Also:

• Search repositories

issues

Iterable<Issue> issues(String keywords,
 String sort,
 Search.Order order,
 EnumMap<Search.Qualifier,String> qualifiers)

Search issues.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

qualifiers - The search qualifier

Returns:

Issues

See Also:

• Search issues

Suppressed Checkstyle violations:

ParameterNumberCheck (7 lines)

users

Iterable<User> users(String keywords,
 String sort,
 Search.Order order)

Search users.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

Returns:

Users

See Also:

• Search users

codes

Iterable<Content> codes(String keywords,
 String sort,
 Search.Order order)

Search code.

Parameters:

keywords - The search keywords

sort - The sort field

order - The sort order

Returns:

Contents

See Also:

• Search code