Package net.thauvin.erik.frankfurter.config

Class RatesConfig.Builder

java.lang.Object

net.thauvin.erik.frankfurter.config.RatesConfig.Builder

Enclosing class:

RatesConfig

public static final class RatesConfig.Builder
extends Object

Builder for creating RatesConfig instances.

All setter methods return this for method chaining. Call build() to create the immutable configuration.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RatesConfig.Builder	base(String base)	Sets the base currency.
RatesConfig.Builder	base(CurrencyCode base)	Sets the base currency.
RatesConfig	build()	Builds and returns an immutable configuration.
RatesConfig.Builder	date(LocalDate date)	Sets a single date for the rate query.
RatesConfig.Builder	from(LocalDate from)	Sets the start of a date range query.
RatesConfig.Builder	group(Group group)	Sets the grouping period.
RatesConfig.Builder	providers(String... providers)	Sets one or more providers.
RatesConfig.Builder	quotes(String... quotes)	Sets one or more quote currencies.
RatesConfig.Builder	quotes(CurrencyCode... quotes)	Sets one or more quote currencies.
RatesConfig.Builder	to(LocalDate to)	Sets the end of a date range query.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

base

@NonNull
public RatesConfig.Builder base(@NonNull
 CurrencyCode base)

Sets the base currency. Optional.

If not set, the Frankfurter API defaults to EUR.

Parameters:

base - the base currency

Returns:

this builder

Throws:

NullPointerException - if base is null

base

@NonNull
public RatesConfig.Builder base(@NonNull
 String base)

Sets the base currency. Optional.

If not set, the Frankfurter API defaults to EUR.

Parameters:

base - 3-letter ISO 4217 currency code, e.g. "USD"

Returns:

this builder

Throws:

NullPointerException - if base is null

IllegalArgumentException - if blank or not 3 letters

build

@NonNull
public RatesConfig build()

Builds and returns an immutable configuration.

Returns:

the immutable config

Throws:

IllegalArgumentException - if date is combined with from/to, or if to is before from

IllegalStateException - if group is set without a date or date range

date

@NonNull
public RatesConfig.Builder date(@NonNull
 LocalDate date)

Sets a single date for the rate query.

Parameters:

date - the date to query, must not be before 1994-01-04

Returns:

this builder

Throws:

NullPointerException - if date is null

IllegalArgumentException - if date is earlier than the minimum supported

from

@NonNull
public RatesConfig.Builder from(@NonNull
 LocalDate from)

Sets the start of a date range query.

Parameters:

from - the start date, must not be before 1994-01-04

Returns:

this builder

Throws:

NullPointerException - if from is null

IllegalArgumentException - if date is earlier than the minimum supported

group

@NonNull
public RatesConfig.Builder group(@NonNull
 Group group)

Sets the grouping period.

Parameters:

group - the grouping, e.g. DAY, MONTH, YEAR

Returns:

this builder

Throws:

NullPointerException - if group is null

providers

@NonNull
public RatesConfig.Builder providers(@NonNull
 String... providers)

Sets one or more providers.

Blank entries are ignored. Duplicates are removed.

Parameters:

providers - provider IDs, e.g. "ECB", "BANXICO"

Returns:

this builder

Throws:

NullPointerException - if array or any element is null

quotes

@NonNull
public RatesConfig.Builder quotes(@NonNull
 String... quotes)

Sets one or more quote currencies.

Blank entries are ignored. Duplicates are removed.

Parameters:

quotes - 3-letter ISO 4217 currency codes, e.g. "USD", "GBP"

Returns:

this builder

Throws:

NullPointerException - if array or any element is null

IllegalArgumentException - if any quote is not 3 letters

quotes

@NonNull
public RatesConfig.Builder quotes(@NonNull
 CurrencyCode... quotes)

Sets one or more quote currencies.

Blank entries are ignored. Duplicates are removed.

Parameters:

quotes - the quote currencies

Returns:

this builder

Throws:

NullPointerException - if array or any element is null

to

@NonNull
public RatesConfig.Builder to(@NonNull
 LocalDate to)

Sets the end of a date range query.

Parameters:

to - the end date, must not be before 1994-01-04

Returns:

this builder

Throws:

NullPointerException - if to is null

IllegalArgumentException - if date is earlier than the minimum supported