Package edu.sustech.search.engine.github.API

Class SearchAPI

java.lang.Object

edu.sustech.search.engine.github.API.RestAPI

edu.sustech.search.engine.github.API.SearchAPI

public class SearchAPI
extends RestAPI

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchAPI.AppendableResultParser	Each time a successful response is received from the server, the parse method will be invoked to parse the raw response body (in String) into a POJO.

Field Summary

Fields inherited from class edu.sustech.search.engine.github.API.RestAPI

TIME_OUT_DURATION

Method Summary

Modifier and Type	Method	Description
static SearchAPI	registerAPI(String... OAuthTokens)	Register a new SearchAPI based on OAuthTokens provided
static SearchAPI	registerAPI(List<String> OAuthTokens)	Register a new SearchAPI based on OAuthTokens provided
HttpResponse<String>	search(SearchRequest request)
CodeResult	searchCode(CodeSearchRequest request1, int count)	This method is a type-restricted implementation of the method searchType.
CodeResult	searchCode(CodeSearchRequest request1, int count, long timeIntervalMillis)	This method is a type-restricted implementation of the method searchType.
CommitResult	searchCommit(CommitSearchRequest request1, int count)	This method is a type-restricted implementation of the method searchType.
CommitResult	searchCommit(CommitSearchRequest request1, int count, long timeIntervalMillis)	This method is a type-restricted implementation of the method searchType.
IPRResult	searchIPR(IPRSearchRequest request1, int count)	Search Issues and Pull-requests.
IPRResult	searchIPR(IPRSearchRequest request1, int count, long timeIntervalMillis)	Search Issues and Pull-requests.
LabelResult	searchLabel(LabelSearchRequest request1, int count)	This method is a type-restricted implementation of the method searchType.
LabelResult	searchLabel(LabelSearchRequest request1, int count, long timeIntervalMillis)	This method is a type-restricted implementation of the method searchType.
List<HttpResponse<String>>	searchLoop(SearchRequest request, int targetPageCount, long timeIntervalMillis)
AppendableResult	searchLoopFetching(SearchRequest request1, SearchAPI.AppendableResultParser p, int count, long timeIntervalMillis)	This method uses while loop to request for search results.
AppendableResult	searchLoopFetching(SearchRequest request1, AppendableResult origin, SearchAPI.AppendableResultParser p, int count, long timeIntervalMillis)	This method uses while loop to request for search results.
String	searchRaw(SearchRequest request)
RepositoryResult	searchRepo(RepoSearchRequest request1, int count)	This method is a type-restricted implementation of the method searchType.
RepositoryResult	searchRepo(RepoSearchRequest request1, int count, long timeIntervalMillis)	This method is a type-restricted implementation of the method searchType.
<T> T	searchResult(SearchRequest request, Class<T> clazz)	Automatically cast request result to the desired form.
TopicResult	searchTopic(TopicSearchRequest request1, int count)	This method is a type-restricted implementation of the method searchType.
TopicResult	searchTopic(TopicSearchRequest request1, int count, long timeIntervalMillis)	This method is a type-restricted implementation of the method searchType.
<T extends AppendableResult> T	searchType(SearchRequest request1, Class<T> targetClazz, int count, long timeIntervalMillis)	This method uses while loop to request for search results.
UserResult	searchUser(UserSearchRequest request1, int count)	This method is a type-restricted implementation of the method searchType.
UserResult	searchUser(UserSearchRequest request1, int count, long timeIntervalMillis)	This method is a type-restricted implementation of the method searchType.
void	setProvidingTextMatch(boolean enabled)	If set to true, the search result will provide text-match metadata.

Methods inherited from class edu.sustech.search.engine.github.API.RestAPI

addToken, convert, getHttpResponse, getHttpResponse, getHttpResponseLoopFetching, getHttpResponseLoopFetching, getHttpResponseLoopFetching, getHttpResponseLoopFetching, getHttpResponseRaw, getHttpResponseRaw, getHttpResponseRawLoopFetching, getHttpResponseRawLoopFetching, getHttpResponseRawLoopFetching, getHttpResponseRawLoopFetching, getNextToken, getRateLimit, getTokenCursor, parseEndPageCount, printRateLimit, setSuppressRateError, setSuppressResponseError, setTokenCursor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

searchIPR

public IPRResult searchIPR(IPRSearchRequest request1,
 int count)
                    throws IOException,
InterruptedException

Search Issues and Pull-requests. This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchIPR

public IPRResult searchIPR(IPRSearchRequest request1,
 int count,
 long timeIntervalMillis)
                    throws IOException,
InterruptedException

Search Issues and Pull-requests. This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchCommit

public CommitResult searchCommit(CommitSearchRequest request1,
 int count)
                          throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchCommit

public CommitResult searchCommit(CommitSearchRequest request1,
 int count,
 long timeIntervalMillis)
                          throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchLabel

public LabelResult searchLabel(LabelSearchRequest request1,
 int count)
                        throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchLabel

public LabelResult searchLabel(LabelSearchRequest request1,
 int count,
 long timeIntervalMillis)
                        throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchTopic

public TopicResult searchTopic(TopicSearchRequest request1,
 int count)
                        throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchTopic

public TopicResult searchTopic(TopicSearchRequest request1,
 int count,
 long timeIntervalMillis)
                        throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchUser

public UserResult searchUser(UserSearchRequest request1,
 int count)
                      throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchUser

public UserResult searchUser(UserSearchRequest request1,
 int count,
 long timeIntervalMillis)
                      throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchCode

public CodeResult searchCode(CodeSearchRequest request1,
 int count)
                      throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchCode

public CodeResult searchCode(CodeSearchRequest request1,
 int count,
 long timeIntervalMillis)
                      throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchRepo

public RepositoryResult searchRepo(RepoSearchRequest request1,
 int count)
                            throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

Returns:

Throws:

IOException

InterruptedException

searchRepo

public RepositoryResult searchRepo(RepoSearchRequest request1,
 int count,
 long timeIntervalMillis)
                            throws IOException,
InterruptedException

This method is a type-restricted implementation of the method searchType. For detailed documentation, see searchType

Parameters:

request1 -

count -

timeIntervalMillis -

Returns:

Throws:

IOException

InterruptedException

searchType

public <T extends AppendableResult> T searchType(SearchRequest request1,
 Class<T> targetClazz,
 int count,
 long timeIntervalMillis)
                                          throws IOException,
InterruptedException

This method uses while loop to request for search results. Please notice that the GitHub REST API may severely restrict your ability to query the result.
If too often the secondary rate limit is encountered, please increase the timeIntervalMillis (a typical recommendation might be 15000), and run this method in another thread.
If multiple OAuthTokens are used, then the time interval between each request can be noticeably reduced.

Type Parameters:

T - Result type

Parameters:

request1 - Request (will create another copy)

targetClazz - Target class for object mapper

count - Target item count. Note that the actual items retrieved might be more

timeIntervalMillis - Preferred time interval between requests

Returns:

CodeResult

Throws:

InterruptedException - Typically when time interval is interrupted

IOException - Typically when connection between this API and the server fails to establish or accidentally closed.

searchLoopFetching

public AppendableResult searchLoopFetching(SearchRequest request1,
 SearchAPI.AppendableResultParser p,
 int count,
 long timeIntervalMillis)
                                    throws InterruptedException,
IOException

This method uses while loop to request for search results. Please notice that the GitHub REST API may severely restrict your ability to query the result.
If too often the secondary rate limit is encountered, please increase the timeIntervalMillis (a typical recommendation might be 15000), and run this method in another thread.
If multiple OAuthTokens are used, then the time interval between each request can be noticeably reduced.

Parameters:

request1 - Request (will create another copy)

p - A functional interface used to parse the result

count - Target item count. Note that the actual items retrieved might be more

timeIntervalMillis - Preferred time interval between requests

Returns:

Results gathered through loop fetching

Throws:

InterruptedException - Typically when time interval is interrupted

IOException - Typically when connection between this API and the server fails to establish or accidentally closed.

searchLoopFetching

public AppendableResult searchLoopFetching(SearchRequest request1,
 AppendableResult origin,
 SearchAPI.AppendableResultParser p,
 int count,
 long timeIntervalMillis)
                                    throws InterruptedException,
IOException

This method uses while loop to request for search results. Please notice that the GitHub REST API may severely restrict your ability to query the result.
If too often the secondary rate limit is encountered, please increase the timeIntervalMillis (a typical recommendation might be 15000), and run this method in another thread.
If multiple OAuthTokens are used, then the time interval between each request can be noticeably reduced.

Parameters:

request1 - Request (will create another copy)

origin - The origin result that waits to be appended on. If null, then a new empty origin will be created.

p - A functional interface used to parse the result

count - Target item count. Note that the actual items retrieved might be more

timeIntervalMillis - Preferred time interval between requests

Returns:

Throws:

InterruptedException

IOException

searchResult

public <T> T searchResult(SearchRequest request,
 Class<T> clazz)
                   throws IOException,
InterruptedException

Automatically cast request result to the desired form.

Type Parameters:

T - Target type

Parameters:

request - Request

clazz - Target type class instance

Returns:

Object result

Throws:

IOException

InterruptedException

searchRaw

public String searchRaw(SearchRequest request)
                 throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

searchLoop

public List<HttpResponse<String>> searchLoop(SearchRequest request,
 int targetPageCount,
 long timeIntervalMillis)
                                      throws IOException,
InterruptedException

Parameters:

request - Request (will create another copy)

targetPageCount - Target page count.

timeIntervalMillis - Preferred time interval between requests

Returns:

Request result

Throws:

IOException

InterruptedException

search

public HttpResponse<String> search(SearchRequest request)
                            throws IOException,
InterruptedException

Parameters:

request - Request (will create another copy)

Returns:

Request result

Throws:

IOException

InterruptedException

setProvidingTextMatch

public void setProvidingTextMatch(boolean enabled)

If set to true, the search result will provide text-match metadata.

Parameters:

enabled - Whether the search result shall enable text-match providing.

registerAPI

public static SearchAPI registerAPI(String... OAuthTokens)

Register a new SearchAPI based on OAuthTokens provided

Parameters:

OAuthTokens - Array of OAuthTokens

Returns:

registerAPI

public static SearchAPI registerAPI(List<String> OAuthTokens)

Register a new SearchAPI based on OAuthTokens provided

Parameters:

OAuthTokens - List of OAuthTokens

Returns: