com.moosemorals.weather

Class WeatherFetcher.Builder

java.lang.Object

com.moosemorals.weather.WeatherFetcher.Builder

Enclosing class:

WeatherFetcher

public static class WeatherFetcher.Builder
extends Object

Build a Fetcher and set its options.

Constructor Summary

Constructors

Constructor and Description
WeatherFetcher.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
WeatherFetcher	build()
WeatherFetcher.Builder	setApiKey(String apiKey) Api key from worldweatheronline.com for their V2 API.
WeatherFetcher.Builder	setCurrent(boolean current) Fetch current conditions.
WeatherFetcher.Builder	setDate(DateTime date) Date to fetch weather for.
WeatherFetcher.Builder	setForecast(boolean forecast) Fetch weather forecast.
WeatherFetcher.Builder	setFrequency(int timePeriod) Frequency of forecasts, in hours.
WeatherFetcher.Builder	setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient) HttpClient to use to fetch.
WeatherFetcher.Builder	setLanguage(String language) Language for human readable text.
WeatherFetcher.Builder	setLocation(String location) Location to fetch for.
WeatherFetcher.Builder	setNumOfDays(int num_of_days) Number of days to fetch.

Methods inherited from class java.lang.Object

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

Constructor Detail

WeatherFetcher.Builder

public WeatherFetcher.Builder()

Method Detail

setApiKey

public WeatherFetcher.Builder setApiKey(String apiKey)

Api key from worldweatheronline.com for their V2 API. Required, no default.

You can register for a key at https://developer.worldweatheronline.com/auth/register

Parameters:

apiKey - String api key to use

Returns:

this Builder for chaining

Throws:

IllegalArgumentException - for a null apiKey

setLocation

public WeatherFetcher.Builder setLocation(String location)

Location to fetch for. Required, no default.

May be a UK or Canadian postcode, US zip code, name of a city, IPv4 address (in dotted quad notation) or Latitude, Longitude pair (decimal degrees, comma separated)

Parameters:

location - String name of the location. The API will work out the type from context.

Returns:

this Builder for chaining

setLanguage

public WeatherFetcher.Builder setLanguage(String language)

Language for human readable text. Optional, default en.

List of availible languages.

Parameters:

language - String ISO language code

Returns:

this Builder for chaining.

setHttpClient

public WeatherFetcher.Builder setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)

HttpClient to use to fetch. Optional, default HttpClients.getDefault().

Provide your own client to manage e.g. cookies, certificates or caching.

Parameters:

httpClient - CloseableHttpClient to use to connect to the API

Returns:

this Builder for chaining.

setNumOfDays

public WeatherFetcher.Builder setNumOfDays(int num_of_days)

Number of days to fetch. Optional, default 3.

Apparently can be as high as 15, but I don't think the free api supports that many.

Parameters:

num_of_days - int number of days to fetch

Returns:

this Builder for chaining

setDate

public WeatherFetcher.Builder setDate(DateTime date)

Date to fetch weather for. Optional, default today.

Parameters:

date - DateTime date to fetch weather for.

Returns:

this Builder for chaining

setForecast

public WeatherFetcher.Builder setForecast(boolean forecast)

Fetch weather forecast. Optional, default true.

False means don't fetch any forecast information.

Parameters:

forecast - boolean true to fetch forecast, false otherwise.

Returns:

this Builder for chaining

setCurrent

public WeatherFetcher.Builder setCurrent(boolean current)

Fetch current conditions. Optional, default true.

False means don't fetch current weather conditions for your location.

Parameters:

current - boolean true to fetch current conditions, false otherwise.

Returns:

this Builder for chaining

setFrequency

public WeatherFetcher.Builder setFrequency(int timePeriod)

Frequency of forecasts, in hours. Optional, default 3.

Can be 3, 6, 12 or 24. Other values are ignored by the API (and revert to 3)

Parameters:

timePeriod - int hours between forecasts

Returns:

this Builder for chaining

build

public WeatherFetcher build()