Package net.thauvin.erik.frankfurter.models

Record Class SeriesRates

java.lang.Object
java.lang.Record
net.thauvin.erik.frankfurter.models.SeriesRates
Record Components:
amount - the amount to be converted or used in calculations
base - the base currency for the time series of exchange rates
startDate - the start date of the time series, formatted as a string
endDate - the end date of the time series, formatted as a string
rates - a map where the keys are dates (LocalDate) and the values are maps of currency codes to their respective exchange rates as doubles
public record SeriesRates(@NotNull Double amount, @NotNull String base, @NotNull String startDate, @NotNull String endDate, @NotNull Map<LocalDate,Map<String,Double>> rates) extends Record
Represents exchange rates over a series of dates for multiple currencies.
Since:
0.9.0
Author:
Erik C. Thauvin

  • Constructor Details

    • SeriesRates

      public SeriesRates(@NotNull @NotNull Double amount, @NotNull @NotNull String base, @NotNull @NotNull String startDate, @NotNull @NotNull String endDate, @NotNull @NotNull Map<LocalDate,Map<String,Double>> rates)
      Constructs an instance of SeriesRates using the provided exchange rate time series.

      The rates map and all inner currency maps are deep-copied into unmodifiable maps. Both startDate and endDate are validated as parseable LocalDate values at construction time.

      Parameters:
      amount - the amount to be converted or used in calculations
      base - the base currency for the time series of exchange rates
      startDate - the start date of the time series, formatted as a string
      endDate - the end date of the time series, formatted as a string
      rates - a map where the keys are dates (LocalDate) and the values are maps of currency codes to their respective exchange rates as doubles; must not be null
      Throws:
      NullPointerException - if rates is null
      DateTimeParseException - if startDate or endDate cannot be parsed

  • Method Details

    • dates

      @NotNull public @NotNull Set<LocalDate> dates()
      Retrieves the set of dates for which exchange rates are available in the time series.
      Returns:
      an unmodifiable copy of the set of dates

    • endLocalDate

      @NotNull public @NotNull LocalDate endLocalDate()
      Retrieves the end date of the time series.
      Returns:
      the end date as a LocalDate

    • hasRatesFor

      public boolean hasRatesFor(@NotNull @NotNull LocalDate date)
      Checks if exchange rates are available for the specified date.
      Parameters:
      date - the date for which to check the availability of exchange rates
      Returns:
      true if exchange rates are available for the specified date, false otherwise

    • hasSymbolFor

      public boolean hasSymbolFor(@NotNull @NotNull LocalDate date, @NotNull @NotNull String symbol)
      Checks if a currency symbol is available for a specified date in the exchange rate time series.
      Parameters:
      date - the LocalDate for which to check the availability of the symbol
      symbol - the currency symbol to check for availability
      Returns:
      true if the symbol is available for the specified date, false otherwise

    • rateFor

      public Double rateFor(@NotNull @NotNull LocalDate date, @NotNull @NotNull String symbol)
      Retrieves the exchange rate for a specific date and currency symbol from the time series.

      It is recommended to call hasRatesFor(LocalDate) and hasSymbolFor(LocalDate, String) before this method to avoid a null return value.

      Parameters:
      date - the date for which the exchange rate is to be retrieved
      symbol - the currency symbol for which the exchange rate is to be retrieved
      Returns:
      the exchange rate for the specified date and currency symbol, or null if no rate is available

    • ratesFor

      @NotNull public @NotNull Map<String,Double> ratesFor(@NotNull @NotNull LocalDate date)
      Retrieves the exchange rates for all currencies on the specified date.
      Parameters:
      date - the date for which the exchange rates are to be retrieved as a LocalDate
      Returns:
      an unmodifiable map of currency symbols to their respective exchange rates on the specified date, or an empty map if no rates are available for the date

    • startLocalDate

      @NotNull public @NotNull LocalDate startLocalDate()
      Retrieves the start date of the time series.
      Returns:
      the start date as a LocalDate

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • amount

      @NotNull public @NotNull Double amount()
      Returns the value of the amount record component.
      Returns:
      the value of the amount record component

    • base

      @NotNull public @NotNull String base()
      Returns the value of the base record component.
      Returns:
      the value of the base record component

    • startDate

      @NotNull public @NotNull String startDate()
      Returns the value of the startDate record component.
      Returns:
      the value of the startDate record component

    • endDate

      @NotNull public @NotNull String endDate()
      Returns the value of the endDate record component.
      Returns:
      the value of the endDate record component

    • rates

      @NotNull public @NotNull Map<LocalDate,Map<String,Double>> rates()
      Returns the value of the rates record component.
      Returns:
      the value of the rates record component