Package tk.plogitech.darksky.forecast

Class ForecastRequestBuilder

java.lang.Object

tk.plogitech.darksky.forecast.ForecastRequestBuilder

public class ForecastRequestBuilder
extends Object

Builder to create ForecastRequest objects.

Author:

Puls

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForecastRequestBuilder.Block	The blocks of the forecast response which can be excluded.
static class	ForecastRequestBuilder.Language	The available Languages in which the forecast response is translated.
static class	ForecastRequestBuilder.Units

Constructor Summary

Constructors

Constructor	Description
ForecastRequestBuilder()

Method Summary

Modifier and Type	Method	Description
ForecastRequest	build()
ForecastRequestBuilder	exclude(ForecastRequestBuilder.Block... block)
ForecastRequestBuilder	extendHourly()	When set, return hour-by-hour data for the next 168 hours, instead of the next 48.
ForecastRequestBuilder	key(APIKey apiKey)
ForecastRequestBuilder	language(ForecastRequestBuilder.Language language)
ForecastRequestBuilder	location(GeoCoordinates geoCoordinates)
ForecastRequestBuilder	time(Instant time)
ForecastRequestBuilder	timeouts(Timeouts timeouts)
ForecastRequestBuilder	units(ForecastRequestBuilder.Units units)
ForecastRequestBuilder	url(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

ForecastRequestBuilder

public ForecastRequestBuilder()

Method Detail

key

public ForecastRequestBuilder key(APIKey apiKey)

Parameters:

apiKey - Your Dark Sky secret key. (Your secret key must be kept secret; in particular, do not embed it in JavaScript source code that you transmit to clients.)

Returns:

This for fluent API.

location

public ForecastRequestBuilder location(GeoCoordinates geoCoordinates)

Parameters:

geoCoordinates - The Geo coordinates of a location for which the weather forecast is requested.

Returns:

This for fluent API.

url

public ForecastRequestBuilder url(String url)

Parameters:

url - Override the default DarksSky API Url. The URL must contain the following patterns for the key and gelocation:
##key## ##latitude## ##longitude##

Returns:

This for fluent API.

language

public ForecastRequestBuilder language(ForecastRequestBuilder.Language language)

Parameters:

language - The summary properties are returned in the desired language. (Note that units in the summary will be set according to the units parameter, so be sure to set both parameters appropriately.)

Returns:

This for fluent API.

extendHourly

public ForecastRequestBuilder extendHourly()

When set, return hour-by-hour data for the next 168 hours, instead of the next 48. When using this option, we strongly recommend enabling HTTP compression.

Returns:

This for fluent API.

exclude

public ForecastRequestBuilder exclude(ForecastRequestBuilder.Block... block)

Parameters:

block - The Blocks which shall be excluded from the response to save data / latency. This method can be called multiple times and the exclusion will add up.

Returns:

This for fluent API.

units

public ForecastRequestBuilder units(ForecastRequestBuilder.Units units)

Parameters:

units - Return weather conditions in the requested units.

Returns:

This for fluent API.

time

public ForecastRequestBuilder time(Instant time)

Parameters:

time - The Time for which the historical weather data is returned.

Returns:

This for fluent API.

timeouts

public ForecastRequestBuilder timeouts(Timeouts timeouts)

Parameters:

timeouts - Override the default timeouts (6 seconds) for connection to the API and reading from the API.

Returns:

This for fluent API.

build

public ForecastRequest build()

Returns:

The Request with the given parameters set.