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

import org.apache.commons.lang.ObjectUtils;
import org.threeten.bp.ZonedDateTime;

import com.opengamma.analytics.financial.instrument.InstrumentDefinition;
import com.opengamma.analytics.financial.interestrate.payments.derivative.Payment;
import com.opengamma.util.ArgumentChecker;
import com.opengamma.util.money.Currency;

/**
 * Class describing a generic payment. The payments can be positive (receiving) or negative (paying).
 */
public abstract class PaymentDefinition implements InstrumentDefinition<Payment> {

  /**
   * The payment currency.
   */
  private final Currency _currency;
  /**
   * The payment date.
   */
  private final ZonedDateTime _paymentDate;

  /**
   * Constructor from payment date.
   * @param currency The payment currency.
   * @param paymentDate The payment date.
   */
  public PaymentDefinition(final Currency currency, final ZonedDateTime paymentDate) {
    ArgumentChecker.notNull(currency, "currency");
    ArgumentChecker.notNull(paymentDate, "payment date");
    _currency = currency;
    _paymentDate = paymentDate;
  }

  /**
   * Gets the payment currency.
   * @return The currency.
   */
  public Currency getCurrency() {
    return _currency;
  }

  /**
   * Gets the payment date.
   * @return The payment date.
   */
  public ZonedDateTime getPaymentDate() {
    return _paymentDate;
  }

  /**
   * Return a reference amount. For coupon it is the notional, for simple payments it is the paid amount. Used mainly to assess if the amount is paid or received.
   * @return The amount.
   */
  public abstract double getReferenceAmount();

  @Override
  public String toString() {
    return "\nPayment Currency = " + _currency + ", Date = " + _paymentDate.toString();
  }

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

  @Override
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final PaymentDefinition other = (PaymentDefinition) obj;
    if (!ObjectUtils.equals(_currency, other._currency)) {
      return false;
    }
    if (!ObjectUtils.equals(_paymentDate, other._paymentDate)) {
      return false;
    }
    return true;
  }

}