com.evrythng.java.wrapper.core

Class EvrythngApiBuilder.Builder<T>

java.lang.Object

com.evrythng.java.wrapper.core.api.ApiCommandBuilder<T,EvrythngApiBuilder.Builder<T>>

com.evrythng.java.wrapper.core.EvrythngApiBuilder.Builder<T>

Enclosing class:

EvrythngApiBuilder

public static class EvrythngApiBuilder.Builder<T>
extends ApiCommandBuilder<T,EvrythngApiBuilder.Builder<T>>

Default command builder for the EVRYTHNG API.

Author:

Pedro De Almeida (almeidap)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvrythngApiBuilder.Builder.Result<R> Class to hold the results and the total count.

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<T>	apiKey(String apiKey)
EvrythngApiBuilder.Builder<T>	app(String appId) Deprecated. Use project to scope a request on a project.
int	count() Deprecated.
EvrythngApiBuilder.Builder<T>	filter(String filter)
EvrythngApiBuilder.Builder<T>	from(ApiConfiguration.QueryKeyword queryKeyword)
EvrythngApiBuilder.Builder<T>	from(long from)
EvrythngApiBuilder.Builder<T>	from(String from)
EvrythngApiBuilder.Builder<T>	ids(List<String> ids)
String	jsonp(String callback) Executes the current command by requesting JSONP in the HttpResponse entity.
EvrythngApiBuilder.Builder.Result<T>	list() Executes the requests and returns a result object.
EvrythngApiBuilder.Builder<T>	page(int page)
EvrythngApiBuilder.Builder<T>	perPage(int perPage)
EvrythngApiBuilder.Builder<T>	project(String projectId)
EvrythngApiBuilder.Builder<T>	search(String pattern)
EvrythngApiBuilder.Builder<T>	to(ApiConfiguration.QueryKeyword queryKeyword)
EvrythngApiBuilder.Builder<T>	to(long to)
EvrythngApiBuilder.Builder<T>	to(String to)
EvrythngApiBuilder.Builder<T>	userScope(Iterable<String> scope)
EvrythngApiBuilder.Builder<T>	userScopeAll() Adds "" query param with value ApiConfiguration.QueryKeyword.ALL
EvrythngApiBuilder.Builder<T>	withPagination(int page, int perPage) Combines page and perPage methods.
EvrythngApiBuilder.Builder<T>	withScopes(boolean withScopes)

Methods inherited from class com.evrythng.java.wrapper.core.api.ApiCommandBuilder

accept, content, execute, getCommand, header, placeHolder, queryParam, queryParam, queryParam, queryParamList, queryParamList, queryParams, request, stream

Methods inherited from class java.lang.Object

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

Method Detail

apiKey

public EvrythngApiBuilder.Builder<T> apiKey(String apiKey)

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

search

public EvrythngApiBuilder.Builder<T> search(String pattern)

Parameters:

pattern - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

See Also:

QSearchQueryParamValue

withScopes

public EvrythngApiBuilder.Builder<T> withScopes(boolean withScopes)

Parameters:

withScopes - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

See Also:

WithScopesQueryParamValue

withPagination

public EvrythngApiBuilder.Builder<T> withPagination(int page,
                                                    int perPage)

Combines page and perPage methods.

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

page

public EvrythngApiBuilder.Builder<T> page(int page)

Parameters:

page - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

perPage

public EvrythngApiBuilder.Builder<T> perPage(int perPage)

Parameters:

perPage - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

from

public EvrythngApiBuilder.Builder<T> from(long from)

Parameters:

from - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

from

public EvrythngApiBuilder.Builder<T> from(String from)

Parameters:

from - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

from

public EvrythngApiBuilder.Builder<T> from(ApiConfiguration.QueryKeyword queryKeyword)

Parameters:

queryKeyword - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

to

public EvrythngApiBuilder.Builder<T> to(long to)

Parameters:

to - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

to

public EvrythngApiBuilder.Builder<T> to(String to)

Parameters:

to - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

to

public EvrythngApiBuilder.Builder<T> to(ApiConfiguration.QueryKeyword queryKeyword)

Parameters:

queryKeyword - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

app

@Deprecated
public EvrythngApiBuilder.Builder<T> app(String appId)

Deprecated. Use project to scope a request on a project.

Does nothing. App query parameter is not used anymore.

Parameters:

appId -

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

userScope

public EvrythngApiBuilder.Builder<T> userScope(Iterable<String> scope)

Parameters:

scope - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

userScopeAll

public EvrythngApiBuilder.Builder<T> userScopeAll()

Adds "" query param with value ApiConfiguration.QueryKeyword.ALL

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

ids

public EvrythngApiBuilder.Builder<T> ids(List<String> ids)

Parameters:

ids - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

filter

public EvrythngApiBuilder.Builder<T> filter(String filter)

Parameters:

filter - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

project

public EvrythngApiBuilder.Builder<T> project(String projectId)

Parameters:

projectId - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

count

@Deprecated
public int count()
                      throws EvrythngException

Deprecated.

Counts the total number of elements if the current command was executed as a HEAD request.

Returns:

the total number of elements matching the current request

Throws:

EvrythngException

See Also:

ApiCommand.head(String)

list

public EvrythngApiBuilder.Builder.Result<T> list()
                                          throws EvrythngException

Executes the requests and returns a result object. The result objects contains the actual object and the total count for the paginated list. This method can only be used in the context of a paginated result set, otherwise an exception is thrown.

Returns:

result object

Throws:

EvrythngException

jsonp

public String jsonp(String callback)
             throws EvrythngException

Executes the current command by requesting JSONP in the HttpResponse entity.

Parameters:

callback - the name of the callback function

Returns:

the HttpResponse entity in the form of JSONP content

Throws:

EvrythngException