Java tutorial
/** * Copyright (C) 2014 - present by OpenGamma Inc. and the OpenGamma group of companies * * Please see distribution for license. */ package com.opengamma.strata.finance.rate; import java.io.Serializable; import java.util.Map; import java.util.NoSuchElementException; import java.util.Set; import org.joda.beans.Bean; 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.google.common.collect.ImmutableSet; import com.opengamma.strata.basics.index.Index; /** * Defines a known fixed rate of interest. * <p> * An interest rate that is specified in the contract or has subsequently been determined. */ @BeanDefinition public final class FixedRateObservation implements RateObservation, ImmutableBean, Serializable { /** * The fixed rate to be paid. * A 5% rate will be expressed as 0.05. */ @PropertyDefinition private final double rate; //------------------------------------------------------------------------- /** * Creates an {@code FixedRateObservation}. * * @param rate the fixed rate * @return the IBOR rate */ public static FixedRateObservation of(double rate) { return FixedRateObservation.builder().rate(rate).build(); } //------------------------------------------------------------------------- @Override public void collectIndices(ImmutableSet.Builder<Index> builder) { // no indices to add } //------------------------- AUTOGENERATED START ------------------------- ///CLOVER:OFF /** * The meta-bean for {@code FixedRateObservation}. * @return the meta-bean, not null */ public static FixedRateObservation.Meta meta() { return FixedRateObservation.Meta.INSTANCE; } static { JodaBeanUtils.registerMetaBean(FixedRateObservation.Meta.INSTANCE); } /** * The serialization version id. */ private static final long serialVersionUID = 1L; /** * Returns a builder used to create an instance of the bean. * @return the builder, not null */ public static FixedRateObservation.Builder builder() { return new FixedRateObservation.Builder(); } private FixedRateObservation(double rate) { this.rate = rate; } @Override public FixedRateObservation.Meta metaBean() { return FixedRateObservation.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 fixed rate to be paid. * A 5% rate will be expressed as 0.05. * @return the value of the property */ public double getRate() { return rate; } //----------------------------------------------------------------------- /** * Returns a builder that allows this bean to be mutated. * @return the mutable builder, not null */ public Builder toBuilder() { return new Builder(this); } @Override public boolean equals(Object obj) { if (obj == this) { return true; } if (obj != null && obj.getClass() == this.getClass()) { FixedRateObservation other = (FixedRateObservation) obj; return JodaBeanUtils.equal(getRate(), other.getRate()); } return false; } @Override public int hashCode() { int hash = getClass().hashCode(); hash = hash * 31 + JodaBeanUtils.hashCode(getRate()); return hash; } @Override public String toString() { StringBuilder buf = new StringBuilder(64); buf.append("FixedRateObservation{"); buf.append("rate").append('=').append(JodaBeanUtils.toString(getRate())); buf.append('}'); return buf.toString(); } //----------------------------------------------------------------------- /** * The meta-bean for {@code FixedRateObservation}. */ 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 rate} property. */ private final MetaProperty<Double> rate = DirectMetaProperty.ofImmutable(this, "rate", FixedRateObservation.class, Double.TYPE); /** * The meta-properties. */ private final Map<String, MetaProperty<?>> metaPropertyMap$ = new DirectMetaPropertyMap(this, null, "rate"); /** * Restricted constructor. */ private Meta() { } @Override protected MetaProperty<?> metaPropertyGet(String propertyName) { switch (propertyName.hashCode()) { case 3493088: // rate return rate; } return super.metaPropertyGet(propertyName); } @Override public FixedRateObservation.Builder builder() { return new FixedRateObservation.Builder(); } @Override public Class<? extends FixedRateObservation> beanType() { return FixedRateObservation.class; } @Override public Map<String, MetaProperty<?>> metaPropertyMap() { return metaPropertyMap$; } //----------------------------------------------------------------------- /** * The meta-property for the {@code rate} property. * @return the meta-property, not null */ public MetaProperty<Double> rate() { return rate; } //----------------------------------------------------------------------- @Override protected Object propertyGet(Bean bean, String propertyName, boolean quiet) { switch (propertyName.hashCode()) { case 3493088: // rate return ((FixedRateObservation) bean).getRate(); } 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 FixedRateObservation}. */ public static final class Builder extends DirectFieldsBeanBuilder<FixedRateObservation> { private double rate; /** * Restricted constructor. */ private Builder() { } /** * Restricted copy constructor. * @param beanToCopy the bean to copy from, not null */ private Builder(FixedRateObservation beanToCopy) { this.rate = beanToCopy.getRate(); } //----------------------------------------------------------------------- @Override public Object get(String propertyName) { switch (propertyName.hashCode()) { case 3493088: // rate return rate; default: throw new NoSuchElementException("Unknown property: " + propertyName); } } @Override public Builder set(String propertyName, Object newValue) { switch (propertyName.hashCode()) { case 3493088: // rate this.rate = (Double) 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 FixedRateObservation build() { return new FixedRateObservation(rate); } //----------------------------------------------------------------------- /** * Sets the fixed rate to be paid. * A 5% rate will be expressed as 0.05. * @param rate the new value * @return this, for chaining, not null */ public Builder rate(double rate) { this.rate = rate; return this; } //----------------------------------------------------------------------- @Override public String toString() { StringBuilder buf = new StringBuilder(64); buf.append("FixedRateObservation.Builder{"); buf.append("rate").append('=').append(JodaBeanUtils.toString(rate)); buf.append('}'); return buf.toString(); } } ///CLOVER:ON //-------------------------- AUTOGENERATED END -------------------------- }