org.javamoney.moneta.function.MajorUnits Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moneta-bp Show documentation

JSR 354 provides an API for representing, transporting, and performing comprehensive calculations with Money and Currency. This module implements JSR 354.

There is a newer version: 1.4.1

Show newest version

/**
 * Copyright (c) 2012, 2014, Credit Suisse (Anatole Tresch), Werner Keil and others by the @author tag.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.javamoney.moneta.function;

import java.math.RoundingMode;
import java.util.Objects;

import javax.money.MonetaryAmount;
import javax.money.MonetaryOperator;
import javax.money.MonetaryQuery;
import javax.money.Monetary;
import javax.money.RoundingQueryBuilder;

/**
 * This class allows to extract the major part of a {@link javax.money.MonetaryAmount}
 * instance.
 *
 * @author Anatole Tresch
 */
final class MajorUnits implements MonetaryQuery {

    private final MonetaryOperator downRounding =
            Monetary.getRounding(RoundingQueryBuilder.of().setScale(0).set(RoundingMode.DOWN).build());

    /**
     * Access the shared instance of {@link MajorUnits} for use.
     */
    MajorUnits() {
    }

    /**
     * Gets the amount in major units as a {@code long}.
     * 
     * This returns the monetary amount in terms of the major units of the
     * currency, truncating the amount if necessary. For example, 'EUR 2.35'
     * will return 2, and 'BHD -1.345' will return -1.
     * 
     * This method matches the API of {@link java.math.BigDecimal}.
     *
     * @return the major units part of the amount
     * @throws ArithmeticException if the amount is too large for a {@code long}
     */
    @Override
    public Long queryFrom(MonetaryAmount amount) {
        Objects.requireNonNull(amount, "Amount required.");
        return amount.with(downRounding).getNumber().longValueExact();
    }
}