javax.money.MonetaryRounding Maven / Gradle / Ivy

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

JSR 354 provides an API for representing, transporting, and performing comprehensive calculations with Money and Currency. This module provides a forward compatible backport of the API.

There is a newer version: 1.0.4

Show newest version

/*
 * CREDIT SUISSE IS WILLING TO LICENSE THIS SPECIFICATION TO YOU ONLY UPON THE CONDITION THAT YOU
 * ACCEPT ALL OF THE TERMS CONTAINED IN THIS AGREEMENT. PLEASE READ THE TERMS AND CONDITIONS OF THIS
 * AGREEMENT CAREFULLY. BY DOWNLOADING THIS SPECIFICATION, YOU ACCEPT THE TERMS AND CONDITIONS OF
 * THE AGREEMENT. IF YOU ARE NOT WILLING TO BE BOUND BY IT, SELECT THE "DECLINE" BUTTON AT THE
 * BOTTOM OF THIS PAGE. Specification: JSR-354 Money and Currency API ("Specification") Copyright
 * (c) 2012-2013, Credit Suisse All rights reserved.
 */
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();

}