javax.money.MonetaryOperator Maven / Gradle / Ivy
Show all versions of money-api-bp Show documentation
/*
* 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-2015, Credit Suisse All rights reserved.
*/
package javax.money;
/**
* Represents an operation on a single {@link MonetaryAmount} that produces a
* result of type {@link MonetaryAmount}.
*
* Examples might be an operator that rounds the amount to the nearest 1000, or
* one that performs currency conversion.
*
* There are two equivalent ways of using a {@code MonetaryOperator}. The first
* is to invoke the method on this interface. The second is to use
* {@link MonetaryAmount#with(MonetaryOperator)}:
*
*
* // these two lines are equivalent, but the second approach is recommended
* monetary = thisOperator.apply(monetary);
* monetary = monetary.with(thisOperator);
*
*
* It is recommended to use the second approach, {@code with(MonetaryOperator)},
* as it is a lot clearer to read in code.
*
* Implementation specification
* The implementation must take the input object and apply it. The
* implementation defines the logic of the operator and is responsible for
* documenting that logic. It may use any method on {@code MonetaryAmount} to
* determine the result.
*
* The input object must not be altered. Instead, an altered copy of the
* original must be returned. This provides equivalent, safe behavior for
* immutable and mutable monetary amounts.
*
* This method may be called from multiple threads in parallel. It must be
* thread-safe when invoked.
*
*
* This interface extends {@code java.util.function.UnaryOperator} introduced by Java 8.
*
* @author Werner Keil
* @author Anatole Tresch
*
* @version 0.9
*/
public interface MonetaryOperator {
/**
* Applies the operator on the given amount.
* @param amount the amount to be operated on.
* @return the applied amount.
*/
MonetaryAmount apply(MonetaryAmount amount);
}