/*
 * Copyright (c) 2012, 2018, Werner Keil, Anatole Tresch and others.
 *
 * 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.
 *
 * Contributors: @manuela-grindei
 */
package org.javamoney.calc.securities;


import javax.money.MonetaryAmount;
import java.math.BigDecimal;

/**
 * The formula for estimated earnings is forecasted sales minus forecasted expenses.
 *
 * @author Manuela Grindei
 * @see <a href="http://www.financeformulas.net/Estimated-Earnings.html">http://www.financeformulas.net/Estimated-Earnings.html</a>
 */
public class EstimatedEarnings {

    /**
     * Private constructor.
     */
    private EstimatedEarnings() {
    }

    /**
     * Calculates the estimated earnings.
     *
     * @param forecastedSales    the forecasted sales
     * @param forecastedExpenses the forecasted expenses
     * @return the estimated earnings
     */
    public static MonetaryAmount calculate(MonetaryAmount forecastedSales, MonetaryAmount forecastedExpenses) {
        return forecastedSales.subtract(forecastedExpenses);
    }

    /**
     * Calculates the estimated earnings.
     *
     * @param projectedSales           the projected sales
     * @param projectedNetProfitMargin the projected net profit margin
     * @return the estimated earnings
     */
    public static MonetaryAmount calculate(MonetaryAmount projectedSales, BigDecimal projectedNetProfitMargin) {
        return projectedSales.multiply(projectedNetProfitMargin);
    }
}
