Rate.java

/*
 *  Copyright (c) 2012, 2013, Credit Suisse (Anatole Tresch), Werner Keil.
 *
 *  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.calc.common;

import com.sun.prism.shader.DrawCircle_LinearGradient_REFLECT_AlphaTest_Loader;
import org.javamoney.moneta.spi.MoneyUtils;

import java.math.BigDecimal;
import java.util.Objects;
import java.util.function.Supplier;

import javax.money.MonetaryAmount;
import javax.money.MonetaryOperator;

/**
 * A rate is simply a multiplicand that is used as a constant, e.g. a calculalatory interest rate.
 * When combined with a {@link MonetaryAmount} the according abosulte rate related to that amount is
 * returned, e.g. a 10 % interest rate is modeled as {@code 0.1}, whereas the absolute value given
 * an amount of {@code USD 100} will be {@code USD 10}.
 * 
 * @author Anatole Tresch
 */
public final class Rate implements MonetaryOperator, Supplier<BigDecimal> {
    /** The rate factor. */
	private BigDecimal rate;
	/** An optional rate info. */
	private String info;

	/** A general zero rate. */
	public static final Rate ZERO = new Rate(BigDecimal.ZERO, null);

    private Rate(BigDecimal rate, String info) {
		this.rate = Objects.requireNonNull(rate);
		this.info = info;
    }

	/**
	 * Creates a new zero rate instance.
	 *
	 * @param info
	 *            the (optional) rate info.
	 */
	public static Rate zero(String info){
		return of(BigDecimal.ZERO, info);
	}

	/**
	 * Creates a new rate instance.
	 * 
	 * @param rate
	 *            the rate, not {@code null}.
	 */
    public static Rate of(BigDecimal rate) {
        return new Rate(rate, null);
    }

	/**
	 * Creates a new rate instance.
	 * @param info the (optional) info String
	 * @param rate
	 *            the rate, not {@code null}.
	 */
	public static Rate of(BigDecimal rate, String info) {
		return new Rate(rate, info);
	}

	/**
	 * Creates a new rate instance.
	 * 
	 * @param rate
	 *            the rate, not {@code null}.
	 */
    public static Rate of(Number rate) {
        return new Rate(MoneyUtils.getBigDecimal(rate), null);
    }

	/**
	 * Creates a new rate instance.
	 *
	 * @param rate
	 *            the rate, not {@code null}.
	 */
	public static Rate of(Number rate, String info) {
		return new Rate(MoneyUtils.getBigDecimal(rate), info);
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((rate == null) ? 0 : rate.hashCode());
		result = prime * result + ((info == null) ? 0 : info.hashCode());
		return result;
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		Rate other = (Rate) obj;
		if (rate == null) {
			if (other.rate != null)
				return false;
		} else if (!rate.equals(other.rate))
			return false;
		if (info == null) {
			if (other.info != null)
				return false;
		} else if (!info.equals(other.info))
			return false;
		return true;
	}

	/**
	 * Access the rate, never {@code null}.
	 * 
	 * @return
	 */
    @Override
    public BigDecimal get() {
        return this.rate;
	}

	/**
	 * Access the additional rate info.
	 * @return the additional rate info, or null.
     */
	public String getInfo(){
		return info;
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		if(info!=null){
			return "Rate[rate=" + rate + ",info="+info+"]";
		}
		return "Rate[" + rate + "]";
	}

	/*
	 * (non-Javadoc)
	 * @see javax.money.MonetaryOperator#apply(javax.money.MonetaryAmount)
	 */
	@Override
	public MonetaryAmount apply(MonetaryAmount amount) {
		return amount.multiply(rate);
	}

}