CouponCommodityDefinition.java

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

import org.threeten.bp.ZonedDateTime;

import com.opengamma.analytics.financial.commodity.multicurvecommodity.underlying.CommodityUnderlying;
import com.opengamma.analytics.financial.instrument.payment.PaymentDefinition;
import com.opengamma.financial.convention.calendar.Calendar;
import com.opengamma.util.ArgumentChecker;
import com.opengamma.util.money.Currency;

/**
 * Class describing a generic commodity coupon.
 */
public abstract class CouponCommodityDefinition extends PaymentDefinition {

  /**
   * The payment period year fraction (or accrual factor).
   */
  private final double _paymentYearFraction;
  /**
   * The underlying commodity
   */
  private final CommodityUnderlying _underlying;

  /** 
   * Description of unit size (for example : a barrel)
   */
  private final String _unitName;

  /** 
   * Notional which is a number of  unit 
   */
  private final double _notional;

  /** 
   * Settlement date. 
   */
  private final ZonedDateTime _settlementDate;

  /**
   * The holiday calendar.
   */
  private final Calendar _calendar;

  /**
   * Constructor with all details.
   * @param paymentYearFraction payment year fraction, positive
   * @param underlying The commodity underlying, not null
   * @param unitName name of the unit of the commodity delivered, not null
   * @param notional the notional
   * @param settlementDate The settlement date, not null
   * @param calendar The holiday calendar, not null
   */
  public CouponCommodityDefinition(final double paymentYearFraction, final CommodityUnderlying underlying, final String unitName, final double notional,
      final ZonedDateTime settlementDate, final Calendar calendar) {
    super(underlying.getCurrency(), settlementDate);
    ArgumentChecker.notNegativeOrZero(paymentYearFraction, "payment year fraction");
    ArgumentChecker.notNull(underlying, "underlying");
    ArgumentChecker.notEmpty(unitName, "unit name");
    ArgumentChecker.notNull(settlementDate, "settlement date");
    ArgumentChecker.notNull(calendar, "calendar");
    _paymentYearFraction = paymentYearFraction;
    _underlying = underlying;
    _unitName = unitName;
    _notional = notional;
    _settlementDate = settlementDate;
    _calendar = calendar;
  }

  /**
   * @return the _paymentYearFraction
   */
  public double getPaymentYearFractione() {
    return _paymentYearFraction;
  }

  /**
   * Gets the commodity underlying.
   * @return commodity underlying.
   */
  public CommodityUnderlying getUnderlying() {
    return _underlying;
  }

  /**
   * @return the _unitName
   */
  public String getUnitName() {
    return _unitName;
  }

  /**
   * @return the _notional
   */
  public double getNotional() {
    return _notional;
  }

  /**
   * @return the _settlementDate
   */
  public ZonedDateTime getSettlementDate() {
    return _settlementDate;
  }

  /**
   * The future currency.
   * @return The currency.
   */
  @Override
  public Currency getCurrency() {
    return _underlying.getCurrency();
  }

  /**
   * Gets the holiday calendar.
   * @return The holiday calendar
   */
  public Calendar getCalendar() {
    return _calendar;
  }

  /* (non-Javadoc)
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((_calendar == null) ? 0 : _calendar.hashCode());
    long temp;
    temp = Double.doubleToLongBits(_paymentYearFraction);
    result = prime * result + (int) (temp ^ (temp >>> 32));
    result = prime * result + ((_settlementDate == null) ? 0 : _settlementDate.hashCode());
    result = prime * result + ((_underlying == null) ? 0 : _underlying.hashCode());
    result = prime * result + ((_unitName == null) ? 0 : _unitName.hashCode());
    return result;
  }

  /* (non-Javadoc)
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final CouponCommodityDefinition other = (CouponCommodityDefinition) obj;
    if (_calendar == null) {
      if (other._calendar != null) {
        return false;
      }
    } else if (!_calendar.equals(other._calendar)) {
      return false;
    }
    if (Double.doubleToLongBits(_paymentYearFraction) != Double.doubleToLongBits(other._paymentYearFraction)) {
      return false;
    }
    if (_settlementDate == null) {
      if (other._settlementDate != null) {
        return false;
      }
    } else if (!_settlementDate.equals(other._settlementDate)) {
      return false;
    }
    if (_underlying == null) {
      if (other._underlying != null) {
        return false;
      }
    } else if (!_underlying.equals(other._underlying)) {
      return false;
    }
    if (_unitName == null) {
      if (other._unitName != null) {
        return false;
      }
    } else if (!_unitName.equals(other._unitName)) {
      return false;
    }
    return true;
  }

}