Class CurrencyAmountArray

    • Method Detail

      • of

        public static CurrencyAmountArray of​(Currency currency,
                                             DoubleArray values)
        Obtains an instance from the specified currency and array of values.
        Parameters:
        currency - the currency of the values
        values - the values
        Returns:
        an instance with the specified currency and values
      • of

        public static CurrencyAmountArray of​(java.util.List<CurrencyAmount> amounts)
        Obtains an instance from the specified list of amounts.

        All amounts must have the same currency.

        Parameters:
        amounts - the amounts, at least size one
        Returns:
        an instance with the specified amounts
        Throws:
        java.lang.IllegalArgumentException - if multiple currencies are found
      • of

        public static CurrencyAmountArray of​(int size,
                                             java.util.function.IntFunction<CurrencyAmount> valueFunction)
        Obtains an instance using a function to create the entries.

        The function is passed the index and returns the CurrencyAmount for that index.

        In some cases it may be possible to specify the currency with a function providing a double. To do this, use DoubleArray.of(int, java.util.function.IntToDoubleFunction) and then call of(Currency, DoubleArray).

        Parameters:
        size - the number of elements, at least size one
        valueFunction - the function used to obtain each value
        Returns:
        an instance initialized using the function
        Throws:
        java.lang.IllegalArgumentException - is size is zero or less
      • size

        public int size()
        Gets the size of the array.
        Returns:
        the array size
      • get

        public CurrencyAmount get​(int index)
        Gets the amount at the specified index.
        Parameters:
        index - the zero-based index to retrieve
        Returns:
        the amount at the specified index
      • stream

        public java.util.stream.Stream<CurrencyAmount> stream()
        Returns a stream of the amounts.
        Returns:
        a stream of the amounts
      • convertedTo

        public CurrencyAmountArray convertedTo​(Currency resultCurrency,
                                               FxRateProvider fxRateProvider)
        Description copied from interface: FxConvertible
        Converts this instance to an equivalent amount in the specified currency.

        The result, which may be of a different type, will be expressed in terms of the given currency. Any FX conversion that is required will use rates from the provider.

        Specified by:
        convertedTo in interface FxConvertible<CurrencyAmountArray>
        Parameters:
        resultCurrency - the currency of the result
        fxRateProvider - the provider of FX rates
        Returns:
        the converted instance, which should be expressed in the specified currency
      • plus

        public CurrencyAmountArray plus​(CurrencyAmountArray other)
        Returns a new array containing the values from this array added to the values in the other array.

        The amounts are added to the matching element in this array. The currency must be the same as the currency of this array. The arrays must have the same size.

        Parameters:
        other - another array of multiple currency values.
        Returns:
        a new array containing the values from this array added to the values in the other array
        Throws:
        java.lang.IllegalArgumentException - if the arrays have different sizes or different currencies
      • plus

        public CurrencyAmountArray plus​(CurrencyAmount amount)
        Returns a new array containing the values from this array with the specified amount added.

        The amount is added to each element in this array. The currency must be the same as the currency of this array.

        Parameters:
        amount - the amount to add
        Returns:
        a new array containing the values from this array with the specified amount added
        Throws:
        java.lang.IllegalArgumentException - if the array and the amount have different currencies
      • minus

        public CurrencyAmountArray minus​(CurrencyAmountArray other)
        Returns a new array containing the values from this array with the values from the other array subtracted.

        The amounts are subtracted from the matching element in this array. The currency must be the same as the currency of this array. The arrays must have the same size.

        Parameters:
        other - another array of multiple currency values.
        Returns:
        a new array containing the values from this array with the values from the other array subtracted
        Throws:
        java.lang.IllegalArgumentException - if the arrays have different sizes or different currencies
      • minus

        public CurrencyAmountArray minus​(CurrencyAmount amount)
        Returns a new array containing the values from this array with the specified amount subtracted.

        The amount is subtracted from each element in this array. The currency must be the same as the currency of this array.

        Parameters:
        amount - the amount to subtract
        Returns:
        a new array containing the values from this array with the specified amount subtracted
        Throws:
        java.lang.IllegalArgumentException - if the array and the amount have different currencies
      • meta

        public static CurrencyAmountArray.Meta meta()
        The meta-bean for CurrencyAmountArray.
        Returns:
        the meta-bean, not null
      • getCurrency

        public Currency getCurrency()
        Gets the currency. All amounts have the same currency.
        Returns:
        the value of the property, not null
      • getValues

        public DoubleArray getValues()
        Gets the values.
        Returns:
        the value of the property, not null
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object