Package de.blackrose01

Class Parameters

java.lang.Object

de.blackrose01.Parameters

public class Parameters
extends Object

Manage Parameters for API requests

Constructor Summary

Constructors

Constructor	Description
Parameters()

Method Summary

Modifier and Type	Method	Description
Parameters	addExclude(String field)	exclude a field in response objects
Parameters	addFields(String fields)	Select the field to show in object
Parameters	addFields(String[] fields)	Select the fields to show in objects
Parameters	addFields(List<String> fields)	Select the fields to show in objects
Parameters	addFilter(String[] values, Postfixes comparator)	set comparising filters
Parameters	addFilter(String field, Postfixes comparator, Number n)	set comparising filters
Parameters	addFilter(String field, Postfixes comparator, String s)	set comparising filters
Parameters	addFilter(List<String> values, Postfixes comparator)	set comparising filters
Parameters	addFilterNull(String field, Postfixes comparator)	set comparising filters (only null checks)
Parameters	addId(long id)	Add single ID as filter
Parameters	addId(long[] id)	Add a bunch of IDs as filter
Parameters	addId(List<Long> id)	Add a bunch of IDs as filter
Parameters	addLimit(int limit)	Maximal size of objects in response max value: 500, min value: 1
Parameters	addOffset(int offset)
Parameters	addOrder(String field, boolean descending)	sort response list by given field
Parameters	addSearch(Endpoint endpoint, String search)	search for given string in name field; sort by similarity only for endpoints Character, Collection, Game, Platform, People Theme
String	buildQuery()	build query string for request
Parameters	resetFilterAll()	delete all parameters
Parameters	resetFilterExclude()	delete parameters for exluding fields
Parameters	resetFilterFields()	delete parameters for fields
Parameters	resetFilterFilters()	delete filter parameters
Parameters	resetFilterIds()	delete parameters for ID
Parameters	resetFilterLimit()	delete parameters for limit
Parameters	resetFilterOffset()	delete parameters for offset
Parameters	resetFilterOrder()	delete parameters for ordering
Parameters	resetFilterSearch()	delete parameters for searching

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Method Detail

addId

public Parameters addId(long id)

Add single ID as filter

Parameters:

id -

Returns:

Parameters object

addId

public Parameters addId(long[] id)

Add a bunch of IDs as filter

Parameters:

id -

Returns:

Parameters object

addId

public Parameters addId(List<Long> id)

Add a bunch of IDs as filter

Parameters:

id -

Returns:

Parameters object

addFields

public Parameters addFields(String fields)

Select the field to show in object

Parameters:

fields -

Returns:

Parameters object

addFields

public Parameters addFields(String[] fields)

Select the fields to show in objects

Parameters:

fields -

Returns:

Parameters object

addFields

public Parameters addFields(List<String> fields)

Select the fields to show in objects

Parameters:

fields -

Returns:

Parameters object

addOffset

public Parameters addOffset(int offset)

Parameters:

offset -

Returns:

Parameters object

addLimit

public Parameters addLimit(int limit)

Maximal size of objects in response max value: 500, min value: 1

Parameters:

limit -

Returns:

Parameters object

addOrder

public Parameters addOrder(String field,
                           boolean descending)

sort response list by given field

Parameters:

field -

descending -

Returns:

Parameters object

addSearch

public Parameters addSearch(Endpoint endpoint,
                            String search)

search for given string in name field; sort by similarity only for endpoints Character, Collection, Game, Platform, People Theme

Parameters:

endpoint -

search -

Returns:

Parameters object

addExclude

public Parameters addExclude(String field)

exclude a field in response objects

Parameters:

field -

Returns:

Parameters object

addFilter

public Parameters addFilter(String field,
                            Postfixes comparator,
                            Number n)

set comparising filters

Parameters:

field -

comparator -

n -

Returns:

Parameters object

addFilter

public Parameters addFilter(String field,
                            Postfixes comparator,
                            String s)

set comparising filters

Parameters:

field -

comparator -

s -

Returns:

Parameters object

addFilterNull

public Parameters addFilterNull(String field,
                                Postfixes comparator)

set comparising filters (only null checks)

Parameters:

field -

comparator -

Returns:

Parameters object

addFilter

public Parameters addFilter(String[] values,
                            Postfixes comparator)

set comparising filters

Parameters:

values -

comparator -

Returns:

Parameters object

addFilter

public Parameters addFilter(List<String> values,
                            Postfixes comparator)

set comparising filters

Parameters:

values -

comparator -

Returns:

Parameters object

resetFilterAll

public Parameters resetFilterAll()

delete all parameters

Returns:

Parameters object

resetFilterIds

public Parameters resetFilterIds()

delete parameters for ID

Returns:

Parameters object

resetFilterFilters

public Parameters resetFilterFilters()

delete filter parameters

Returns:

Parameters object

resetFilterFields

public Parameters resetFilterFields()

delete parameters for fields

Returns:

Parameters object

resetFilterOrder

public Parameters resetFilterOrder()

delete parameters for ordering

Returns:

Parameters object

resetFilterOffset

public Parameters resetFilterOffset()

delete parameters for offset

Returns:

Parameters object

resetFilterLimit

public Parameters resetFilterLimit()

delete parameters for limit

Returns:

Parameters object

resetFilterSearch

public Parameters resetFilterSearch()

delete parameters for searching

Returns:

Parameters object

resetFilterExclude

public Parameters resetFilterExclude()

delete parameters for exluding fields

Returns:

Parameters object

buildQuery

public String buildQuery()

build query string for request

Returns:

parameterized query string