/**
 * Copyright (C) 2014 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.analytics.financial.interestrate.swap.derivative;

import org.apache.commons.lang.ObjectUtils;

import com.opengamma.analytics.financial.interestrate.InstrumentDerivative;
import com.opengamma.analytics.financial.interestrate.annuity.derivative.Annuity;
import com.opengamma.analytics.financial.interestrate.payments.derivative.Payment;
import com.opengamma.util.ArgumentChecker;

/**
 * Description of a total return swap: funding leg. The asset is described in the child classes.
 */
public abstract class TotalReturnSwap implements InstrumentDerivative {

  /** The funding leg */
  private final Annuity<? extends Payment> _fundingLeg;
  /** The time to effective date */
  private final double _effectiveTime;
  /** The time to termination date */
  private final double _terminationTime;

  /**
   * Constructor of the bond TRS.
   * @param effectiveTime The time to the effective date.
   * @param terminatioTime The time to the termination date.
   * @param fundingLeg The funding leg, not null
   */
  public TotalReturnSwap(final double effectiveTime, final double terminatioTime, final Annuity<? extends Payment> fundingLeg) {
    ArgumentChecker.notNull(fundingLeg, "fundingLeg");
    _fundingLeg = fundingLeg;
    _effectiveTime = effectiveTime;
    _terminationTime = terminatioTime;
  }

  /**
   * Gets the funding leg.
   * @return The funding leg
   */
  public Annuity<? extends Payment> getFundingLeg() {
    return _fundingLeg;
  }

  /**
   * Returns the time to the effective date.
   * @return The time.
   */
  public double getEffectiveTime() {
    return _effectiveTime;
  }

  /**
   * Returns the time to the termination date.
   * @return The time.
   */
  public double getTerminationTime() {
    return _terminationTime;
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + _fundingLeg.hashCode();
    return result;
  }

  @Override
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (!(obj instanceof TotalReturnSwap)) {
      return false;
    }
    final TotalReturnSwap other = (TotalReturnSwap) obj;
    if (!ObjectUtils.equals(_fundingLeg, other._fundingLeg)) {
      return false;
    }
    return true;
  }
}