Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- 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 - Class in net.thauvin.erik.frankfurter
-
The AvailableCurrencies class is a utility class that provides methods to retrieve information about available currencies.
B
- 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
LatestRates
using the current state of theLatestRates.Builder
. - build() - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Builds and returns a new instance of the
TimeSeries
class 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.
- closingDays(int) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Calculates a list of target closing days for a given year.
- Currencies - Class in net.thauvin.erik.frankfurter.models
-
Represents a map of available currency symbols to their full names.
- Currencies() - Constructor for class net.thauvin.erik.frankfurter.models.Currencies
D
- 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.
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class net.thauvin.erik.frankfurter.models.LocalDateAdapter
E
- endDate(LocalDate) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the end date for the builder using a
LocalDate
object. - equals(Object) - Method in record class net.thauvin.erik.frankfurter.models.Error
-
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
Error
record class. - EUR - Static variable in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
The Euro currency code.
- ExchangeRates - Class in net.thauvin.erik.frankfurter.models
-
Represents the latest exchange rates for a base currency.
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.
- formatCurrency(String, Double) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
Formats a currency amount based on the provided ISO currency symbol and amount.
- formatCurrency(String, Double, boolean) - Static method in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
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
- getAmount() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the amount of the latest exchange rate or time series.
- getAmount() - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the amount of the base currency.
- getAmount() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the amount of the time series.
- getAmount() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the amount associated with the current time series.
- getBase() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the base currency for the current rates or time series.
- getBase() - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the base currency.
- getBase() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the base currency of the time series.
- getBase() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the base currency for the current time series.
- getCurrencies() - Static method in class net.thauvin.erik.frankfurter.AvailableCurrencies
-
Fetches the collection of available currencies and their corresponding full names.
- getDate() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the date associated with the latest exchange rates.
- getDate() - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the date of the exchange rates.
- getDates() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the set of dates for which exchange rates are available in the time series.
- getEndDate() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the end date of the time series.
- getEndDate() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the end date associated with the time series.
- getExchangeRates() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the latest exchange rates based on a specified base currency, date, and optional symbols.
- getFullNameFor(String) - Method in class net.thauvin.erik.frankfurter.models.Currencies
-
Retrieves the full name of a currency by its symbol.
- getPeriodicRates() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the periodic exchange rates for a time series based on the specified input parameters.
- getRateFor(String) - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the exchange rate for the specified currency symbol.
- getRateFor(LocalDate, String) - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the exchange rate for a specific date and currency symbol from the time series.
- getRates() - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the exchange rates for various currencies.
- getRates() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the exchange rates mapped by date and currency symbol.
- getRatesFor(LocalDate) - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the exchange rates for all currencies on the specified date.
- getStartDate() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Retrieves the start date of the time series.
- getStartDate() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the start date associated with the time series.
- getStatusCode() - Method in exception net.thauvin.erik.frankfurter.exceptions.HttpErrorException
-
Gets the HTTP status code.
- getSymbolFor(String) - Method in class net.thauvin.erik.frankfurter.models.Currencies
-
Retrieves the currency symbol corresponding to the given currency name.
- getSymbolFor(Pattern) - Method in class net.thauvin.erik.frankfurter.models.Currencies
-
Retrieves the currency symbol corresponding to a currency name that matches the given regular expression pattern.
- getSymbols() - Method in class net.thauvin.erik.frankfurter.LatestRates
-
Retrieves the collection of currency symbols associated with the rates.
- getSymbols() - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Retrieves the set of all currency symbols available in the exchange rates.
- getSymbols() - Method in class net.thauvin.erik.frankfurter.TimeSeries
-
Retrieves the collection of currency symbols associated with the time series.
- getUri() - Method in exception net.thauvin.erik.frankfurter.exceptions.HttpErrorException
-
Gets the URI.
H
- hashCode() - Method in record class net.thauvin.erik.frankfurter.models.Error
-
Returns a hash code value for this object.
- hasRateFor(String) - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
-
Checks if the exchange rates contain the specified currency symbol.
- hasRatesFor(LocalDate) - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
-
Checks if exchange rates are available for the specified date.
- hasSymbolFor(LocalDate, String) - Method in 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, List<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 LatestRates instance using the specified Builder.
- LatestRates.Builder - Class in net.thauvin.erik.frankfurter
-
Builder class to create and configure an instance of
LatestRates
. - LocalDateAdapter - Class in net.thauvin.erik.frankfurter.models
-
A custom adapter for serializing and deserializing
LocalDate
objects using Gson. - LocalDateAdapter() - Constructor for class net.thauvin.erik.frankfurter.models.LocalDateAdapter
- 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
message
record component. - MIN_DATE - Static variable in class net.thauvin.erik.frankfurter.FrankfurterUtils
-
The minimum date supported by the Frankfurter API.
N
- net.thauvin.erik.frankfurter - package net.thauvin.erik.frankfurter
- net.thauvin.erik.frankfurter.exceptions - package net.thauvin.erik.frankfurter.exceptions
- net.thauvin.erik.frankfurter.models - package net.thauvin.erik.frankfurter.models
- 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.
S
- serialize(LocalDate, Type, JsonSerializationContext) - Method in class net.thauvin.erik.frankfurter.models.LocalDateAdapter
- SeriesRates - Class in net.thauvin.erik.frankfurter.models
- startDate(LocalDate) - Method in class net.thauvin.erik.frankfurter.TimeSeries.Builder
-
Sets the start date for the builder using a
LocalDate
object. - 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
-
The Builder class provides a flexible way to construct instances of the TimeSeries class.
- toString() - Method in record class net.thauvin.erik.frankfurter.models.Error
-
Returns a string representation of this record class.
- toString() - Method in class net.thauvin.erik.frankfurter.models.ExchangeRates
- toString() - Method in class net.thauvin.erik.frankfurter.models.SeriesRates
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