com.evrythng.java.wrapper.core

Interface EvrythngApiBuilder.Builder<TYPE>

All Known Implementing Classes:

EvrythngApiBuilder.CheckedBuilder

Enclosing class:

EvrythngApiBuilder

public static interface EvrythngApiBuilder.Builder<TYPE>

Nested Class Summary

Nested Classes

Modifier and Type	Interface 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<TYPE>	accept(String mediaType) Sets the value of the Accept HTTP header.
EvrythngApiBuilder.Builder<TYPE>	apiKey(String apiKey)
EvrythngApiBuilder.Builder<TYPE>	app(String appId) Deprecated. Use project to scope a request on a project.
String	content() Executes the current command and returns the HttpResponse entity content as String.
int	count() Deprecated.
TYPE	execute() Executes the current command and maps the HttpResponse entity to T specified by ApiCommand.responseType.
TypedResponseWithEntity<TYPE>	executeWithResponse()
EvrythngApiBuilder.Builder<TYPE>	filter(String filter)
EvrythngApiBuilder.Builder<TYPE>	from(ApiConfiguration.QueryKeyword queryKeyword)
EvrythngApiBuilder.Builder<TYPE>	from(long from)
EvrythngApiBuilder.Builder<TYPE>	from(String from)
ApiCommand<TYPE>	getCommand()
EvrythngApiBuilder.Builder<TYPE>	header(String name, String value) Sets a request header or removes it if value equals null.
EvrythngApiBuilder.Builder<TYPE>	ids(List<String> ids)
String	jsonp(String callback) Executes the current command by requesting JSONP in the HttpResponse entity.
EvrythngApiBuilder.Builder.Result<TYPE>	list() Executes the requests and returns a result object.
EvrythngApiBuilder.Builder<TYPE>	page(int page)
EvrythngApiBuilder.Builder<TYPE>	perPage(int perPage)
EvrythngApiBuilder.Builder<TYPE>	placeHolder(Boolean placeHolder)
EvrythngApiBuilder.Builder<TYPE>	project(String projectId)
EvrythngApiBuilder.Builder<TYPE>	queryParam(QueryParamValue qpv) Sets a query parameter or removes it if the value equals null.
EvrythngApiBuilder.Builder<TYPE>	queryParam(String name, List<String> value) Sets a multi-valued query parameter or removes it if value equals null.
EvrythngApiBuilder.Builder<TYPE>	queryParam(String name, String value) Sets a query parameter or removes it if value equals null
EvrythngApiBuilder.Builder<TYPE>	queryParamList(String name, List<String> values) Sets a multi-valued query parameter or removes it if value equals null.
EvrythngApiBuilder.Builder<TYPE>	queryParamList(String name, String... values) Sets a multi-valued query parameter or removes it if value equals null.
EvrythngApiBuilder.Builder<TYPE>	queryParams(Map<String,String> params) Sets the provided query parametes.
org.apache.http.HttpResponse	request() Executes the current command and returns the native HttpResponse.
EvrythngApiBuilder.Builder<TYPE>	search(String pattern)
EvrythngApiBuilder.Builder<TYPE>	sortOrder(com.evrythng.commons.domain.SortOrder sortOrder)
InputStream	stream() Executes the current command and returns the HttpResponse content InputStream.
EvrythngApiBuilder.Builder<TYPE>	to(ApiConfiguration.QueryKeyword queryKeyword)
EvrythngApiBuilder.Builder<TYPE>	to(long to)
EvrythngApiBuilder.Builder<TYPE>	to(String to)
EvrythngApiBuilder.Builder<TYPE>	userScope(Iterable<String> scope)
EvrythngApiBuilder.Builder<TYPE>	userScopeAll() Adds "" query param with value ApiConfiguration.QueryKeyword.ALL
EvrythngApiBuilder.Builder<TYPE>	withPagination(int page, int perPage) Combines page and perPage methods.
EvrythngApiBuilder.Builder<TYPE>	withScopes(boolean withScopes)

Method Detail

executeWithResponse

TypedResponseWithEntity<TYPE> executeWithResponse()
                                           throws EvrythngException

Throws:

EvrythngException

queryParam

EvrythngApiBuilder.Builder<TYPE> queryParam(String name,
                                            String value)

Sets a query parameter or removes it if value equals null

Parameters:

name - the query parameter name

value - the query parameter value

Returns:

the current EvrythngApiBuilder.Builder instance

placeHolder

EvrythngApiBuilder.Builder<TYPE> placeHolder(Boolean placeHolder)

queryParam

EvrythngApiBuilder.Builder<TYPE> queryParam(QueryParamValue qpv)

Sets a query parameter or removes it if the value equals null.

Parameters:

qpv - the name and the value of the query parameter.

Returns:

the current EvrythngApiBuilder.Builder instance

queryParam

EvrythngApiBuilder.Builder<TYPE> queryParam(String name,
                                            List<String> value)

Sets a multi-valued query parameter or removes it if value equals null.

Parameters:

name - parameter name

value - parameter values or null

Returns:

the current EvrythngApiBuilder.Builder instance

queryParamList

EvrythngApiBuilder.Builder<TYPE> queryParamList(String name,
                                                List<String> values)

Sets a multi-valued query parameter or removes it if value equals null.

Parameters:

name - parameter name

values - parameter values or null

Returns:

the current EvrythngApiBuilder.Builder instance

queryParamList

EvrythngApiBuilder.Builder<TYPE> queryParamList(String name,
                                                String... values)

Sets a multi-valued query parameter or removes it if value equals null.

Parameters:

name - parameter name

values - parameter values or null

Returns:

the current EvrythngApiBuilder.Builder instance

queryParams

EvrythngApiBuilder.Builder<TYPE> queryParams(Map<String,String> params)

Sets the provided query parametes.

Parameters:

params - a map name/value entries

Returns:

the current EvrythngApiBuilder.Builder instance

See Also:

queryParam(String, String)

header

EvrythngApiBuilder.Builder<TYPE> header(String name,
                                        String value)

Sets a request header or removes it if value equals null.

Parameters:

name - request header name

value - the request header value

Returns:

the current EvrythngApiBuilder.Builder instance

accept

EvrythngApiBuilder.Builder<TYPE> accept(String mediaType)

Sets the value of the Accept HTTP header.

Parameters:

mediaType - a valid media type for the Accept HTTP header

Returns:

the current EvrythngApiBuilder.Builder instance

execute

TYPE execute()
      throws EvrythngException

Executes the current command and maps the HttpResponse entity to T specified by ApiCommand.responseType.

Returns:

the HttpResponse entity mapped to T

Throws:

EvrythngException

See Also:

ApiCommand.execute()

content

String content()
        throws EvrythngException

Executes the current command and returns the HttpResponse entity content as String.

Returns:

the HttpResponse entity content as String

Throws:

EvrythngException

See Also:

ApiCommand.content()

request

org.apache.http.HttpResponse request()
                              throws EvrythngException

Executes the current command and returns the native HttpResponse.

Returns:

the HttpResponse resulting from the request

Throws:

EvrythngException

See Also:

ApiCommand.request()

stream

InputStream stream()
            throws EvrythngException

Executes the current command and returns the HttpResponse content InputStream.

Returns:

the InputStream of the HttpResponse

Throws:

EvrythngException

See Also:

ApiCommand.stream()

getCommand

ApiCommand<TYPE> getCommand()

Returns:

ApiCommand instance

apiKey

EvrythngApiBuilder.Builder<TYPE> apiKey(String apiKey)

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

search

EvrythngApiBuilder.Builder<TYPE> search(String pattern)

Parameters:

pattern - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

See Also:

QSearchQueryParamValue

sortOrder

EvrythngApiBuilder.Builder<TYPE> sortOrder(com.evrythng.commons.domain.SortOrder sortOrder)

Parameters:

sortOrder - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

See Also:

SortOrderQueryParamValue

withScopes

EvrythngApiBuilder.Builder<TYPE> withScopes(boolean withScopes)

Parameters:

withScopes - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

See Also:

WithScopesQueryParamValue

withPagination

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

Combines page and perPage methods.

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

page

EvrythngApiBuilder.Builder<TYPE> page(int page)

Parameters:

page - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

perPage

EvrythngApiBuilder.Builder<TYPE> perPage(int perPage)

Parameters:

perPage - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

from

EvrythngApiBuilder.Builder<TYPE> from(long from)

Parameters:

from - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

from

EvrythngApiBuilder.Builder<TYPE> from(String from)

Parameters:

from - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

from

EvrythngApiBuilder.Builder<TYPE> from(ApiConfiguration.QueryKeyword queryKeyword)

Parameters:

queryKeyword - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

to

EvrythngApiBuilder.Builder<TYPE> to(long to)

Parameters:

to - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

to

EvrythngApiBuilder.Builder<TYPE> to(String to)

Parameters:

to - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

to

EvrythngApiBuilder.Builder<TYPE> to(ApiConfiguration.QueryKeyword queryKeyword)

Parameters:

queryKeyword - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

app

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

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

Does nothing. App query parameter is not used anymore.

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

userScope

EvrythngApiBuilder.Builder<TYPE> userScope(Iterable<String> scope)

Parameters:

scope - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

userScopeAll

EvrythngApiBuilder.Builder<TYPE> userScopeAll()

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

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

ids

EvrythngApiBuilder.Builder<TYPE> ids(List<String> ids)

Parameters:

ids - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

filter

EvrythngApiBuilder.Builder<TYPE> filter(String filter)

Parameters:

filter - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

project

EvrythngApiBuilder.Builder<TYPE> project(String projectId)

Parameters:

projectId - "" query parameter value

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

count

@Deprecated
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

EvrythngApiBuilder.Builder.Result<TYPE> 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

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