Package net.thauvin.erik.frankfurter.config

Class RateConfig.Builder

java.lang.Object

net.thauvin.erik.frankfurter.config.RateConfig.Builder

Enclosing class:

RateConfig

public static final class RateConfig.Builder
extends Object

Builder for RateConfig.

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
RateConfig.Builder	base(String base)	Sets the base currency.
RateConfig.Builder	base(CurrencyCode base)	Sets the base currency.
RateConfig	build()	Builds the configuration.
RateConfig.Builder	date(LocalDate date)	Sets an optional historical date.
RateConfig.Builder	providers(String... providers)	Sets optional provider filters.
RateConfig.Builder	quote(String quote)	Sets the quote currency.
RateConfig.Builder	quote(CurrencyCode quote)	Sets the quote currency.

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 RateConfig.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 RateConfig.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 RateConfig build()

Builds the configuration.

Returns:

the immutable config

Throws:

IllegalStateException - if quote currency not set

IllegalArgumentException - if base and quote are the same

date

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

Sets an optional historical date.

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

providers

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

Sets optional provider filters.

Blank entries are ignored. Duplicates are removed. The array is defensively copied.

Parameters:

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

Returns:

this builder

Throws:

NullPointerException - if array or any element is null

quote

@NonNull
public RateConfig.Builder quote(@NonNull
 CurrencyCode quote)

Sets the quote currency. Required.

Parameters:

quote - the quote currency

Returns:

this builder

Throws:

NullPointerException - if quote is null

quote

@NonNull
public RateConfig.Builder quote(@NonNull
 String quote)

Sets the quote currency. Required.

Parameters:

quote - 3-letter ISO 4217 currency code, e.g. "EUR"

Returns:

this builder

Throws:

NullPointerException - if quote is null

IllegalArgumentException - if blank or not 3 letters