org.javamoney.moneta.function.MonetarySummaryStatistics 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;

/**
 * A state object for collecting statistics such as count, min, max, sum, and
 * average.
 * @author otaviojava
 * @author Anatole Tresch
 */
public interface MonetarySummaryStatistics {

	/**
	 * Records another value into the summary information.
	 * @param amount
	 *            the input amount value to be added, not null.
	 */
	void accept(MonetaryAmount amount);

	/**
	 * Combines the state of another {@code MonetarySummaryStatistics} into this
	 * one.
	 * @param summaryStatistics
	 *            another {@code MonetarySummaryStatistics}, not null.
	 */
	MonetarySummaryStatistics combine(
			MonetarySummaryStatistics summaryStatistics);

   /**
     * Get the number of items added to this summary instance.
     * @return the number of summarized items, >= 0.
     */
    long getCount();

    /**
     * Get the minimal amount found within this summary.
     * @return the minimal amount, or null if no amount was added to this summary instance.
     */
	MonetaryAmount getMin();

    /**
     * Get the maximal amount found within this summary.
     * @return the minimal amount, or null if no amount was added to this summary instance.
     */
	MonetaryAmount getMax();

    /**
     * Get the sum of all amounts within this summary.
     * @return the total amount, or null if no amount was added to this summary instance.
     */
	MonetaryAmount getSum();

    /**
     * Get the mean average of all amounts added.
     * @return the mean average amount, or null if no amount was added to this summary instance.
     */
	MonetaryAmount getAverage();

	/**
	 * the currency unit used in summary
	 * @return the currency unit
	 */
	CurrencyUnit getCurrencyUnit();

	/**
	 * return if is possible do exchange rate or not with the MonetarySummary
	 * @return false;
	 */
	boolean isExchangeable();

	/**
	 * created the MonetarySummaryStatistics converted to {@link CurrencyUnit}
	 * @param unit
	 *            to be converted
	 * @return MonetarySummaryStatistics converted
	 * @throws UnsupportedOperationException
	 *             if {@link MonetarySummaryStatistics#isExchangeable()} was
	 *             false
	 * @throws NullPointerException
	 *             if unit was null
	 */
	MonetarySummaryStatistics to(CurrencyUnit unit);

}