javax.money.CurrencySupplier 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;


/**
 * Represents a supplier of {@link CurrencyUnit}-valued results. This is the
 * {@link CurrencyUnit}-producing specialization of {@code Supplier} (as in Java 8).
 * 
 * 
 * There is no requirement that a distinct result be returned each time the
 * supplier is invoked.
 * 
 * 

 * This is a functional interface whose
 * functional method is {@link #getCurrency()}.
 * This class does not extend {@link java.util.function.Supplier} since {@link javax.money.MonetaryAmount} implements
 * both supplier interfaces, {@link javax.money.NumberSupplier} and {@link javax.money.CurrencySupplier},
 * which will lead
 * to method name conflicts.
 * 
 *
 * @author Werner Keil
 * @version 0.5
 * @since 0.8
 * @see java.util.function.Supplier
 */
@FunctionalInterface
public interface CurrencySupplier {

	/**
	 * Gets the corresponding {@link javax.money.CurrencyUnit}.
	 * 
	 * @return the corresponding {@link javax.money.CurrencyUnit}, not null.
	 */
	CurrencyUnit getCurrency();
}