com.opengamma.strata.market.curve.RatesCurveGroupId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of strata-market Show documentation
Entities describing the financial market
The newest version!
/*
 * Copyright (C) 2015 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.market.curve;

import java.io.Serializable;
import java.lang.invoke.MethodHandles;

import org.joda.beans.ImmutableBean;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaBean;
import org.joda.beans.TypedMetaBean;
import org.joda.beans.gen.BeanDefinition;
import org.joda.beans.gen.PropertyDefinition;
import org.joda.beans.impl.light.LightMetaBean;

import com.opengamma.strata.data.MarketDataId;
import com.opengamma.strata.data.ObservableSource;

/**
 * An identifier used to access a curve group by name.
 * 
 * This is used when there is a need to obtain an instance of {@link RatesCurveGroup}.
 */
@BeanDefinition(style = "light", cacheHashCode = true)
public final class RatesCurveGroupId
    implements MarketDataId, ImmutableBean, Serializable {

  /**
   * The curve group name.
   */
  @PropertyDefinition(validate = "notNull")
  private final CurveGroupName curveGroupName;
  /**
   * The source of observable market data.
   */
  @PropertyDefinition(validate = "notNull")
  private final ObservableSource observableSource;

  //-------------------------------------------------------------------------
  /**
   * Obtains an instance used to obtain a curve group by name.
   *
   * @param groupName  the curve group name
   * @return the identifier
   */
  public static RatesCurveGroupId of(String groupName) {
    return new RatesCurveGroupId(CurveGroupName.of(groupName), ObservableSource.NONE);
  }

  /**
   * Obtains an instance used to obtain a curve group by name.
   *
   * @param groupName  the curve group name
   * @return the identifier
   */
  public static RatesCurveGroupId of(CurveGroupName groupName) {
    return new RatesCurveGroupId(groupName, ObservableSource.NONE);
  }

  /**
   * Obtains an instance used to obtain a curve group by name, specifying the source of observable market data.
   *
   * @param groupName  the curve group name
   * @param obsSource  source of observable market data
   * @return the identifier
   */
  public static RatesCurveGroupId of(CurveGroupName groupName, ObservableSource obsSource) {
    return new RatesCurveGroupId(groupName, obsSource);
  }

  //-------------------------------------------------------------------------
  @Override
  public Class getMarketDataType() {
    return RatesCurveGroup.class;
  }

  @Override
  public String toString() {
    return new StringBuilder(32)
        .append("RatesCurveGroupId:")
        .append(curveGroupName)
        .append(observableSource.equals(ObservableSource.NONE) ? "" : "/" + observableSource)
        .toString();
  }

  //------------------------- AUTOGENERATED START -------------------------
  /**
   * The meta-bean for {@code RatesCurveGroupId}.
   */
  private static final TypedMetaBean META_BEAN =
      LightMetaBean.of(
          RatesCurveGroupId.class,
          MethodHandles.lookup(),
          new String[] {
              "curveGroupName",
              "observableSource"},
          new Object[0]);

  /**
   * The meta-bean for {@code RatesCurveGroupId}.
   * @return the meta-bean, not null
   */
  public static TypedMetaBean meta() {
    return META_BEAN;
  }

  static {
    MetaBean.register(META_BEAN);
  }

  /**
   * The serialization version id.
   */
  private static final long serialVersionUID = 1L;

  /**
   * The cached hash code, using the racy single-check idiom.
   */
  private transient int cacheHashCode;

  private RatesCurveGroupId(
      CurveGroupName curveGroupName,
      ObservableSource observableSource) {
    JodaBeanUtils.notNull(curveGroupName, "curveGroupName");
    JodaBeanUtils.notNull(observableSource, "observableSource");
    this.curveGroupName = curveGroupName;
    this.observableSource = observableSource;
  }

  @Override
  public TypedMetaBean metaBean() {
    return META_BEAN;
  }

  //-----------------------------------------------------------------------
  /**
   * Gets the curve group name.
   * @return the value of the property, not null
   */
  public CurveGroupName getCurveGroupName() {
    return curveGroupName;
  }

  //-----------------------------------------------------------------------
  /**
   * Gets the source of observable market data.
   * @return the value of the property, not null
   */
  public ObservableSource getObservableSource() {
    return observableSource;
  }

  //-----------------------------------------------------------------------
  @Override
  public boolean equals(Object obj) {
    if (obj == this) {
      return true;
    }
    if (obj != null && obj.getClass() == this.getClass()) {
      RatesCurveGroupId other = (RatesCurveGroupId) obj;
      return JodaBeanUtils.equal(curveGroupName, other.curveGroupName) &&
          JodaBeanUtils.equal(observableSource, other.observableSource);
    }
    return false;
  }

  @Override
  public int hashCode() {
    int hash = cacheHashCode;
    if (hash == 0) {
      hash = getClass().hashCode();
      hash = hash * 31 + JodaBeanUtils.hashCode(curveGroupName);
      hash = hash * 31 + JodaBeanUtils.hashCode(observableSource);
      cacheHashCode = hash;
    }
    return hash;
  }

  //-------------------------- AUTOGENERATED END --------------------------
}