/**
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.basics.index;
import java.io.Serializable;
import java.time.YearMonth;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import org.joda.beans.Bean;
import org.joda.beans.BeanBuilder;
import org.joda.beans.BeanDefinition;
import org.joda.beans.ImmutableBean;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaProperty;
import org.joda.beans.Property;
import org.joda.beans.PropertyDefinition;
import org.joda.beans.impl.direct.DirectFieldsBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaBean;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.opengamma.strata.basics.currency.Currency;
/**
* Information about a single observation of a Price index.
* <p>
* Observing a Price index requires knowledge of the index and fixing date.
*/
@BeanDefinition(builderScope = "private")
public final class PriceIndexObservation
implements IndexObservation, ImmutableBean, Serializable {
/**
* The FX index.
* <p>
* The rate will be queried from this index.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final PriceIndex index;
/**
* The fixing month.
* <p>
* The index will be observed for this month.
*/
@PropertyDefinition(validate = "notNull")
private final YearMonth fixingMonth;
//-------------------------------------------------------------------------
/**
* Creates an instance from an index and fixing date.
* <p>
* The reference data is used to find the maturity date from the fixing date.
*
* @param index the index
* @param fixingMonth the fixing month
* @return the rate observation
*/
public static PriceIndexObservation of(PriceIndex index, YearMonth fixingMonth) {
return new PriceIndexObservation(index, fixingMonth);
}
//-----------------------------------------------------------------------
/**
* Gets the currency of the Ibor index.
*
* @return the currency of the index
*/
public Currency getCurrency() {
return index.getCurrency();
}
//-------------------------------------------------------------------------
/**
* Compares this observation to another based on the index and fixing date.
* <p>
* The maturity date is ignored.
*
* @param obj the other observation
* @return true if equal
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
PriceIndexObservation other = (PriceIndexObservation) obj;
return index.equals(other.index) && fixingMonth.equals(other.fixingMonth);
}
return false;
}
/**
* Returns a hash code based on the index and fixing date.
* <p>
* The maturity date is ignored.
*
* @return the hash code
*/
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + index.hashCode();
return hash * 31 + fixingMonth.hashCode();
}
@Override
public String toString() {
return new StringBuilder(64)
.append("PriceIndexObservation[")
.append(index)
.append(" on ")
.append(fixingMonth)
.append(']')
.toString();
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code PriceIndexObservation}.
* @return the meta-bean, not null
*/
public static PriceIndexObservation.Meta meta() {
return PriceIndexObservation.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(PriceIndexObservation.Meta.INSTANCE);
}
/**
* The serialization version id.
*/
private static final long serialVersionUID = 1L;
private PriceIndexObservation(
PriceIndex index,
YearMonth fixingMonth) {
JodaBeanUtils.notNull(index, "index");
JodaBeanUtils.notNull(fixingMonth, "fixingMonth");
this.index = index;
this.fixingMonth = fixingMonth;
}
@Override
public PriceIndexObservation.Meta metaBean() {
return PriceIndexObservation.Meta.INSTANCE;
}
@Override
public <R> Property<R> property(String propertyName) {
return metaBean().<R>metaProperty(propertyName).createProperty(this);
}
@Override
public Set<String> propertyNames() {
return metaBean().metaPropertyMap().keySet();
}
//-----------------------------------------------------------------------
/**
* Gets the FX index.
* <p>
* The rate will be queried from this index.
* @return the value of the property, not null
*/
@Override
public PriceIndex getIndex() {
return index;
}
//-----------------------------------------------------------------------
/**
* Gets the fixing month.
* <p>
* The index will be observed for this month.
* @return the value of the property, not null
*/
public YearMonth getFixingMonth() {
return fixingMonth;
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code PriceIndexObservation}.
*/
public static final class Meta extends DirectMetaBean {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code index} property.
*/
private final MetaProperty<PriceIndex> index = DirectMetaProperty.ofImmutable(
this, "index", PriceIndexObservation.class, PriceIndex.class);
/**
* The meta-property for the {@code fixingMonth} property.
*/
private final MetaProperty<YearMonth> fixingMonth = DirectMetaProperty.ofImmutable(
this, "fixingMonth", PriceIndexObservation.class, YearMonth.class);
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"index",
"fixingMonth");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty<?> metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case 100346066: // index
return index;
case 265281235: // fixingMonth
return fixingMonth;
}
return super.metaPropertyGet(propertyName);
}
@Override
public BeanBuilder<? extends PriceIndexObservation> builder() {
return new PriceIndexObservation.Builder();
}
@Override
public Class<? extends PriceIndexObservation> beanType() {
return PriceIndexObservation.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code index} property.
* @return the meta-property, not null
*/
public MetaProperty<PriceIndex> index() {
return index;
}
/**
* The meta-property for the {@code fixingMonth} property.
* @return the meta-property, not null
*/
public MetaProperty<YearMonth> fixingMonth() {
return fixingMonth;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case 100346066: // index
return ((PriceIndexObservation) bean).getIndex();
case 265281235: // fixingMonth
return ((PriceIndexObservation) bean).getFixingMonth();
}
return super.propertyGet(bean, propertyName, quiet);
}
@Override
protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) {
metaProperty(propertyName);
if (quiet) {
return;
}
throw new UnsupportedOperationException("Property cannot be written: " + propertyName);
}
}
//-----------------------------------------------------------------------
/**
* The bean-builder for {@code PriceIndexObservation}.
*/
private static final class Builder extends DirectFieldsBeanBuilder<PriceIndexObservation> {
private PriceIndex index;
private YearMonth fixingMonth;
/**
* Restricted constructor.
*/
private Builder() {
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case 100346066: // index
return index;
case 265281235: // fixingMonth
return fixingMonth;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case 100346066: // index
this.index = (PriceIndex) newValue;
break;
case 265281235: // fixingMonth
this.fixingMonth = (YearMonth) newValue;
break;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
return this;
}
@Override
public Builder set(MetaProperty<?> property, Object value) {
super.set(property, value);
return this;
}
@Override
public Builder setString(String propertyName, String value) {
setString(meta().metaProperty(propertyName), value);
return this;
}
@Override
public Builder setString(MetaProperty<?> property, String value) {
super.setString(property, value);
return this;
}
@Override
public Builder setAll(Map<String, ? extends Object> propertyValueMap) {
super.setAll(propertyValueMap);
return this;
}
@Override
public PriceIndexObservation build() {
return new PriceIndexObservation(
index,
fixingMonth);
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(96);
buf.append("PriceIndexObservation.Builder{");
buf.append("index").append('=').append(JodaBeanUtils.toString(index)).append(',').append(' ');
buf.append("fixingMonth").append('=').append(JodaBeanUtils.toString(fixingMonth));
buf.append('}');
return buf.toString();
}
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}