Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(String, String) - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Adds a new currency with symbol and name, using
Locale.ROOTas the default locale. - add(Currency) - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Adds a new currency to the registry.
- amount() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the amount of the latest exchange rate or time series.
- amount() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Returns the value of the
amountrecord component. - amount() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns the value of the
amountrecord component. - amount() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the amount associated with the current time series.
- amount(int) - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Sets the amount for the builder.
- amount(int) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the amount for the builder.
- amount(Double) - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Sets the amount for the builder.
- amount(Double) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the amount for the builder.
- API_BASE_URL - Static variable in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
The base URL for the Frankfurter API.
- availableCurrencies() - Static method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Fetches the collection of available currencies and their corresponding full names from the Frankfurter API.
B
- base() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the base currency for the current rates or time series.
- base() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Returns the value of the
baserecord component. - base() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns the value of the
baserecord component. - base() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the base currency for the current time series.
- base(String) - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Sets the base currency for the builder after formatting it to follow the required symbol format.
- base(String) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the base currency symbol for the builder.
- build() - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Builds and returns a new instance of
LatestRatesusing the current state of theLatestRates.Builder. - build() - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Builds and returns a new instance of the
TimeSeriesclass using the current state of the Builder. - Builder() - Constructor for class net.thauvin.erik.frankfurter.LatestRates.Builder
- Builder() - Constructor for class net.thauvin.erik.frankfurter.TimeSeries.Builder
C
- calculateEasterMonday(int) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Calculates Easter Monday for a given year.
- calculateEasterSunday(int) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Calculates Easter Sunday for a given year using the Western (Gregorian) calendar.
- calculateGoodFriday(int) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Calculates Good Friday for a given year.
- clearPatternCache() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Clears the pattern cache to free memory.
- closingDays(int) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Calculates a list of target closing days for a given year.
- contains(String) - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Checks if any currency matches the given symbol pattern using regular expression (case-insensitive).
- Currency - Record Class in net.thauvin.erik.frankfurter.models
- Currency(String, String, Locale) - Constructor for record class net.thauvin.erik.frankfurter.models.Currency
-
Creates an instance of a
Currencyrecord class. - CurrencyFormatter - Class in net.thauvin.erik.frankfurter
-
Utility class for formatting currency values.
- CurrencyRegistry - Class in net.thauvin.erik.frankfurter
-
The CurrencyRegistry class serves as a central repository for managing a collection of currencies.
D
- date() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the date associated with the latest exchange rates.
- date() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Returns the value of the
daterecord component. - date(LocalDate) - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Sets the date for the builder after validating it to ensure it is not earlier than January 4, 1994.
- dates() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the set of dates for which exchange rates are available in the time series.
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class net.thauvin.erik.frankfurter.models.LocalDateAdapter
E
- endDate() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns the value of the
endDaterecord component. - endDate() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the end date associated with the time series.
- endDate(LocalDate) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the end date for the builder using a
LocalDateobject. - endLocalDate() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the end date of the time series.
- equals(Object) - Method in record class net.thauvin.erik.frankfurter.models.Currency
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.thauvin.erik.frankfurter.models.Error
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Indicates whether some other object is "equal to" this one.
- Error - Record Class in net.thauvin.erik.frankfurter.models
-
Represents error information returned by the application or service.
- Error(String) - Constructor for record class net.thauvin.erik.frankfurter.models.Error
-
Creates an instance of a
Errorrecord class. - EUR - Static variable in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
The Euro currency code.
- exchangeRates() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the latest exchange rates based on a specified base currency, date, and optional symbols.
- ExchangeRates - Record Class in net.thauvin.erik.frankfurter.models
-
Represents the exchange rates for a base currency.
- ExchangeRates(Double, String, LocalDate, Map<String, Double>) - Constructor for record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Constructs a new instance of the ExchangeRates record.
F
- fetchUri(URI) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Sends an HTTP GET request to the specified URI and retrieves the response body as a string.
- findByName(String) - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Finds a currency by its name using a regular expression pattern (case-insensitive).
- findBySymbol(String) - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Finds a currency by its symbol using a regular expression pattern (case-insensitive).
- format(String, Double) - Static method in class net.thauvin.erik.frankfurter.CurrencyFormatter
-
Formats a currency amount based on the provided ISO currency symbol and amount.
- format(String, Double, boolean) - Static method in class net.thauvin.erik.frankfurter.CurrencyFormatter
-
Formats a currency amount based on the provided ISO currency symbol, amount, and rounding preference.
- FrankfurterUtils - Class in net.thauvin.erik.frankfurter
-
Utility class for interacting with the Frankfurter API and performing related operations.
G
- getAllCurrencies() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Returns all currencies in the registry as an unmodifiable list.
- getAllSymbols() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Retrieves all currency symbols available in the registry.
- getInstance() - Static method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Gets the default singleton instance of the currency registry.
- getStatusCode() - Method in exception net.thauvin.erik.frankfurter.exceptions.HttpErrorException
-
Gets the HTTP status code.
- getUri() - Method in exception net.thauvin.erik.frankfurter.exceptions.HttpErrorException
-
Gets the URI.
H
- hashCode() - Method in record class net.thauvin.erik.frankfurter.models.Currency
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.thauvin.erik.frankfurter.models.Error
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns a hash code value for this object.
- hasRateFor(String) - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Checks if the exchange rates contain the specified currency symbol.
- hasRatesFor(LocalDate) - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Checks if exchange rates are available for the specified date.
- hasSymbolFor(LocalDate, String) - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Checks if a symbol is available for a specified date in the exchange rate time series.
- HttpErrorException - Exception in net.thauvin.erik.frankfurter.exceptions
-
Exception representing HTTP errors with status codes.
- HttpErrorException(int, String, URI) - Constructor for exception net.thauvin.erik.frankfurter.exceptions.HttpErrorException
-
Creates an HttpErrorException with status code and message.
- HttpErrorException(int, String, URI, Throwable) - Constructor for exception net.thauvin.erik.frankfurter.exceptions.HttpErrorException
-
Creates an HttpErrorException with status code, message, and cause.
I
- isValidSymbol(String) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Validates whether the provided symbol is a non-null string consisting of exactly three alphabetical characters (either uppercase or lowercase).
- isWeekend(LocalDate) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Determines whether the given date falls on a weekend (Saturday or Sunday).
- isWorkingDay(LocalDate, Collection<LocalDate>) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Determines whether the specified date is a working day.
L
- LatestRates - Class in net.thauvin.erik.frankfurter
-
Represents the latest exchange rates based on a specific base currency, date, and symbols.
- LatestRates(LatestRates.Builder) - Constructor for class net.thauvin.erik.frankfurter.LatestRates
-
Constructs a new
LatestRatesinstance using the specified Builder. - LatestRates.Builder - Class in net.thauvin.erik.frankfurter
-
Builder class to construct instances of the
LatestRatesclass. - LocalDateAdapter - Class in net.thauvin.erik.frankfurter.models
-
Custom adapter for serializing and deserializing
LocalDateobjects using Gson. - LocalDateAdapter() - Constructor for class net.thauvin.erik.frankfurter.models.LocalDateAdapter
- locale() - Method in record class net.thauvin.erik.frankfurter.models.Currency
-
Returns the value of the
localerecord component. - LOGGER - Static variable in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
The logger for this class.
M
- message() - Method in record class net.thauvin.erik.frankfurter.models.Error
-
Returns the value of the
messagerecord component. - MIN_DATE - Static variable in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
The minimum date supported by the Frankfurter API.
N
- name() - Method in record class net.thauvin.erik.frankfurter.models.Currency
-
Returns the value of the
namerecord component. - net.thauvin.erik.frankfurter - package net.thauvin.erik.frankfurter
-
Retrieve reference exchange rates from Frankfurter.dev, a free, open-source currency data API.
- net.thauvin.erik.frankfurter.exceptions - package net.thauvin.erik.frankfurter.exceptions
-
Provides custom exception classes.
- net.thauvin.erik.frankfurter.models - package net.thauvin.erik.frankfurter.models
-
Provides the data models for the Frankfurter.dev API.
- normalizeSymbol(String) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Formats a given currency symbol to uppercase if it matches the required format of three alphabetical characters.
P
- patternCacheSize() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Returns the current size of the pattern cache.
- periodicRates() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the periodic exchange rates for a time series based on the specified input parameters.
R
- rateFor(String) - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the exchange rate for the specified currency symbol.
- rateFor(LocalDate, String) - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the exchange rate for a specific date and currency symbol from the time series.
- rates() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Returns the value of the
ratesrecord component. - rates() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns the value of the
ratesrecord component. - ratesFor(LocalDate) - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the exchange rates for all currencies on the specified date.
- refresh() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Fetches the collection of available currencies and their corresponding full names.
- reset() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Resets the registry to its original default state.
S
- search(String) - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Searches for currencies by code or name using a regular expression pattern (case-insensitive).
- serialize(LocalDate, Type, JsonSerializationContext) - Method in class net.thauvin.erik.frankfurter.models.LocalDateAdapter
- SeriesRates - Record Class in net.thauvin.erik.frankfurter.models
-
Represents exchange rates over a series of dates for multiple currencies.
- SeriesRates(Double, String, String, String, Map<LocalDate, Map<String, Double>>) - Constructor for record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Constructs an instance of
SeriesRatesusing the provided exchange rate time series. - size() - Method in class net.thauvin.erik.frankfurter.CurrencyRegistry
-
Returns the number of currencies in the registry.
- startDate() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns the value of the
startDaterecord component. - startDate() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the start date associated with the time series.
- startDate(LocalDate) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the start date for the builder using a
LocalDateobject. - startLocalDate() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the start date of the time series.
- symbol() - Method in record class net.thauvin.erik.frankfurter.models.Currency
-
Returns the value of the
symbolrecord component. - symbols() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the list of currency symbols associated with the rates.
- symbols() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the set of all currency symbols available in the exchange rates.
- symbols() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the list of currency symbols associated with the time series.
- symbols(String...) - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Adds one or more currency symbols to the builder after formatting each symbol to follow the required format.
- symbols(String...) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the currency symbols for the builder using a variable number of string arguments.
- symbols(Collection<String>) - Method in class net.thauvin.erik.frankfurter.LatestRates.Builder
-
Adds a collection of currency symbols to the builder after formatting each symbol to follow the required format.
- symbols(Collection<String>) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the currency symbols for the builder using a collection of string arguments.
T
- TimeSeries - Class in net.thauvin.erik.frankfurter
-
Represents a time series of currency exchange rate data for a specified base currency over a defined date range.
- TimeSeries(TimeSeries.Builder) - Constructor for class net.thauvin.erik.frankfurter.TimeSeries
-
Constructs a new instance of the TimeSeries class using the specified builder object.
- TimeSeries.Builder - Class in net.thauvin.erik.frankfurter
-
Builder class to construct instances of the
TimeSeriesclass. - toString() - Method in record class net.thauvin.erik.frankfurter.models.Currency
-
Returns a string representation of this record class.
- toString() - Method in record class net.thauvin.erik.frankfurter.models.Error
-
Returns a string representation of this record class.
- toString() - Method in record class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Returns a string representation of this record class.
- toString() - Method in record class net.thauvin.erik.frankfurter.models.SeriesRates
-
Returns a string representation of this record class.
U
- uriBuilder(String, Map<String, String>) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Builds a URI by combining the
API_BASE_URL base url, a specified path, and query parameters.
V
- validateDate(LocalDate) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Validates the provided date.
W
- workingDays(LocalDate, LocalDate) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Calculates a list of working days between two given dates, excluding weekends (Saturdays and Sundays) and target closing days.
Y
- yearsBetween(LocalDate, LocalDate) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Retrieves a list of all years in the range between the provided start date and end date, inclusive.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form