com.opengamma.strata.market.curve.IssuerCurveInputsId Maven / Gradle / Ivy
Show all versions of strata-market Show documentation
/*
* Copyright (C) 2018 - 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 the inputs to curve calibration.
*
* This is used when there is a need to obtain an instance of {@link RatesCurveInputs}.
*/
@BeanDefinition(style = "light", cacheHashCode = true)
public final class IssuerCurveInputsId
implements MarketDataId, ImmutableBean, Serializable {
/**
* The curve group name.
*/
@PropertyDefinition(validate = "notNull")
private final CurveGroupName curveGroupName;
/**
* The curve name.
*/
@PropertyDefinition(validate = "notNull")
private final CurveName curveName;
/**
* The source of observable market data.
*/
@PropertyDefinition(validate = "notNull")
private final ObservableSource observableSource;
//-------------------------------------------------------------------------
/**
* Obtains an instance from the curve group name, curve name and source of observable market data.
*
* @param groupName the curve group name
* @param curveName the curve name
* @param obsSource the source of observable market data
* @return the identifier
*/
public static IssuerCurveInputsId of(
CurveGroupName groupName,
CurveName curveName,
ObservableSource obsSource) {
return new IssuerCurveInputsId(groupName, curveName, obsSource);
}
//-------------------------------------------------------------------------
@Override
public Class getMarketDataType() {
return RatesCurveInputs.class;
}
@Override
public String toString() {
return new StringBuilder(32)
.append("IssuerCurveInputsId:")
.append(curveGroupName)
.append('/')
.append(curveName)
.append(observableSource.equals(ObservableSource.NONE) ? "" : "/" + observableSource)
.toString();
}
//------------------------- AUTOGENERATED START -------------------------
/**
* The meta-bean for {@code IssuerCurveInputsId}.
*/
private static final TypedMetaBean META_BEAN =
LightMetaBean.of(
IssuerCurveInputsId.class,
MethodHandles.lookup(),
new String[] {
"curveGroupName",
"curveName",
"observableSource"},
new Object[0]);
/**
* The meta-bean for {@code IssuerCurveInputsId}.
* @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 IssuerCurveInputsId(
CurveGroupName curveGroupName,
CurveName curveName,
ObservableSource observableSource) {
JodaBeanUtils.notNull(curveGroupName, "curveGroupName");
JodaBeanUtils.notNull(curveName, "curveName");
JodaBeanUtils.notNull(observableSource, "observableSource");
this.curveGroupName = curveGroupName;
this.curveName = curveName;
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 curve name.
* @return the value of the property, not null
*/
public CurveName getCurveName() {
return curveName;
}
//-----------------------------------------------------------------------
/**
* 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()) {
IssuerCurveInputsId other = (IssuerCurveInputsId) obj;
return JodaBeanUtils.equal(curveGroupName, other.curveGroupName) &&
JodaBeanUtils.equal(curveName, other.curveName) &&
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(curveName);
hash = hash * 31 + JodaBeanUtils.hashCode(observableSource);
cacheHashCode = hash;
}
return hash;
}
//-------------------------- AUTOGENERATED END --------------------------
}