Package de.chojo.universalis.rest.routes.requests

Class HistoryRequestImpl

java.lang.Object

de.chojo.universalis.rest.requests.RequestBuilder<HistoryResponse>

de.chojo.universalis.rest.routes.requests.HistoryRequestImpl

All Implemented Interfaces:

Request<HistoryResponse>, DataCenterScope<RegionHistoryRequest>, ItemScope<HistoryRequest>, LimitedRequest<HistoryRequest>, RegionScope<RegionHistoryRequest>, WorldScope<RegionHistoryRequest>, BlankHistoryRequest, RegionHistoryRequest, HistoryRequest

public class HistoryRequestImpl
extends RequestBuilder<HistoryResponse>
implements HistoryRequest

Implementation for a HistoryRequest

Field Summary

Fields inherited from class de.chojo.universalis.rest.requests.RequestBuilder

rest

Constructor Summary

Constructors

Constructor	Description
HistoryRequestImpl(UniversalisRestImpl rest)	Create a new history request

Method Summary

Modifier and Type	Method	Description
HistoryRequest	dataCenter(DataCenter dataCenter)	Data center scope of the request.
HistoryRequest	historyTime(Duration duration)	The amount of time before now to take entries within the history data returned by MarketBoardResponse.recentHistory().
HistoryRequest	items(Item... items)	Items to lookup
HistoryRequest	items(Collection<Item> items)	Items to lookup
HistoryRequest	itemsIds(Integer... itemIds)	Item ids to lookup
HistoryRequest	itemsIds(Collection<Integer> itemIds)	Item ids to lookup
HistoryRequest	limit(int limit)	Set the limit of retrieved entries for this request
HistoryRequest	region(Region region)	Region scope of the request.
HistoryRequest	statsTime(Duration duration)	The amount of time before now to calculate stats over.
HistoryRequest	world(World world)	World scope of the request.

Methods inherited from class de.chojo.universalis.rest.requests.RequestBuilder

complete, parameter, path, path, queue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.chojo.universalis.rest.requests.Request

complete, queue

Constructor Details

HistoryRequestImpl

public HistoryRequestImpl(UniversalisRestImpl rest)

Create a new history request

Parameters:

rest - rest client

Method Details

region

@CheckReturnValue
public HistoryRequest region(Region region)

Description copied from interface: RegionScope

Region scope of the request.

Calling this again will remove other scopes.

Specified by:

region in interface RegionScope<RegionHistoryRequest>

Parameters:

region - region

Returns:

request builder

dataCenter

@CheckReturnValue
public HistoryRequest dataCenter(DataCenter dataCenter)

Description copied from interface: DataCenterScope

Data center scope of the request.

Calling this again will remove other scopes.

Specified by:

dataCenter in interface DataCenterScope<RegionHistoryRequest>

Parameters:

dataCenter - data center

Returns:

request builder

world

@CheckReturnValue
public HistoryRequest world(World world)

Description copied from interface: WorldScope

World scope of the request.

Calling this again will remove other scopes.

Specified by:

world in interface WorldScope<RegionHistoryRequest>

Parameters:

world - world

Returns:

request builder

items

@CheckReturnValue
public HistoryRequest items(Item... items)

Description copied from interface: ItemScope

Items to lookup

Specified by:

items in interface ItemScope<HistoryRequest>

Parameters:

items - items

Returns:

request builder

items

@CheckReturnValue
public HistoryRequest items(Collection<Item> items)

Description copied from interface: ItemScope

Items to lookup

Specified by:

items in interface ItemScope<HistoryRequest>

Parameters:

items - items

Returns:

request builder

itemsIds

@CheckReturnValue
public HistoryRequest itemsIds(Integer... itemIds)

Description copied from interface: ItemScope

Item ids to lookup

Specified by:

itemsIds in interface ItemScope<HistoryRequest>

Parameters:

itemIds - item ids

Returns:

request builder

itemsIds

@CheckReturnValue
public HistoryRequest itemsIds(Collection<Integer> itemIds)

Description copied from interface: ItemScope

Item ids to lookup

Specified by:

itemsIds in interface ItemScope<HistoryRequest>

Parameters:

itemIds - item ids

Returns:

request builder

limit

@CheckReturnValue
public HistoryRequest limit(int limit)

Description copied from interface: HistoryRequest

Set the limit of retrieved entries for this request

Default: 1800 Max: 999999

Specified by:

limit in interface HistoryRequest

Specified by:

limit in interface LimitedRequest<HistoryRequest>

Parameters:

limit - limit

Returns:

request builder

historyTime

@CheckReturnValue
public HistoryRequest historyTime(Duration duration)

Description copied from interface: HistoryRequest

The amount of time before now to take entries within the history data returned by MarketBoardResponse.recentHistory().

Specified by:

historyTime in interface HistoryRequest

Parameters:

duration - duration

Returns:

request

statsTime

@CheckReturnValue
public HistoryRequest statsTime(Duration duration)

Description copied from interface: HistoryRequest

The amount of time before now to calculate stats over. By default, this is 7 days.

Affects MarketBoardResponse.saleVelocity()

Specified by:

statsTime in interface HistoryRequest

Parameters:

duration - duration

Returns:

request