org.javamoney.moneta.function.MonetaryAmountProducer 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 javax.money.CurrencyUnit;
import javax.money.MonetaryAmount;

/**
 *The producer of {@link MonetaryAmount} from {@link CurrencyUnit} and {@link Number}
 * @author Otavio Santana
 * @see {@link FastMoneyProducer}
 * @see {@link MoneyProducer}
 * @see {@link RoundedMoneyProducer}
 * @since 1.0.1
 */
public interface MonetaryAmountProducer {
	/**
	 * Creates a {@link MonetaryAmount} from {@link CurrencyUnit} and {@link Number}
	 * @param currency
	 * @param number
	 * @return a {@link MonetaryAmount} never null
	 * @throws NullPointerException if currency and Number is null
	 */
	MonetaryAmount create(CurrencyUnit currency, Number number);

}