javax.money.MonetaryRounding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of money-api Show documentation

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

The newest version!

/*
 * Copyright 2012-2016 Credit Suisse
 * Copyright 2018-2020 Werner Keil, Otavio Santana, Trivadis AG
 *
 * 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 javax.money;

/**
 * Interface representing a monetary rounding. Rounding must not necessarily represent roundings in a pure arithmetical sense. Basically a rounding
 * can scale an amount arbitrarily.
 * Implementation specification
 * Implementations of this interface must be
 * 
 *     final
 *     immutable
 *     thread-safe
 * 
 * Implementations of this interface should be
 * 
 *     serializable
 * 
 */
public interface MonetaryRounding extends MonetaryOperator{

    /**
     * Access the rounding's context, which gives more details of the rounding instances such as
     * 
     *     The rounding's name (required)
     *     Its provider (required)
     *     Its base currency
     *     its scale and rounding mode
     *     any other attributes useful to describe the rounding
     * 
     * @return the rounding's context, never null.
     */
    RoundingContext getRoundingContext();

}