Class ReportingCurrency

    • Field Detail

      • NONE

        public static final ReportingCurrency NONE
        An instance requesting no currency conversion.

        Calculation results are normally converted to a single currency. If this reporting currency is used, then no currency conversion will be performed.

    • Method Detail

      • of

        public static ReportingCurrency of​(Currency currency)
        Obtains an instance requesting the specified currency.

        When converting calculation results, conversion will occur to the specified currency. This returns an instance with the type ReportingCurrencyType.SPECIFIC.

        Parameters:
        currency - the specific currency
        Returns:
        a reporting currency instance requesting the specified currency
      • isSpecific

        public boolean isSpecific()
        Checks if the type is 'Specific'.

        When converting calculation results, conversion will occur to the specific currency returned by getCurrency().

        Returns:
        true if the type is 'Specific'
      • isNone

        public boolean isNone()
        Checks if the type is 'None'.

        Calculation results are normally converted to a single currency. If this returns true than no currency conversion will be performed.

        Returns:
        true if the type is 'None'
      • getCurrency

        public Currency getCurrency()
        Gets the currency if the type is 'Specific'.

        If the type is 'Specific', this returns the currency. Otherwise, this throws an exception. As such, the type must be checked using #is

        Returns:
        the currency, only available if the type is 'Specific'
        Throws:
        java.lang.IllegalStateException - if called on a failure result
      • toString

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

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

        public ReportingCurrencyType getType()
        Gets the type of reporting currency.
        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