/**
* Copyright (C) 2014 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.financial.security.option;
import java.util.Map;
import org.joda.beans.Bean;
import org.joda.beans.BeanBuilder;
import org.joda.beans.BeanDefinition;
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.DirectBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.opengamma.financial.security.FinancialSecurity;
import com.opengamma.financial.security.FinancialSecurityVisitor;
import com.opengamma.id.ExternalId;
import com.opengamma.master.security.SecurityDescription;
import com.opengamma.util.money.Currency;
import com.opengamma.util.time.Expiry;
/**
*
*/
@BeanDefinition
@SecurityDescription(type = EquityWarrantSecurity.SECURITY_TYPE, description = "Equity warrant")
public class EquityWarrantSecurity extends FinancialSecurity {
/** Serialization version. */
private static final long serialVersionUID = 1L;
/**
* The security type.
*/
public static final String SECURITY_TYPE = "EQUITY_WARRANT";
/**
* The option type.
*/
@PropertyDefinition(validate = "notNull")
private OptionType _optionType;
/**
* The strike.
*/
@PropertyDefinition
private double _strike;
/**
* The currency.
*/
@PropertyDefinition(validate = "notNull")
private Currency _currency;
/**
* The underlying identifier.
*/
@PropertyDefinition(validate = "notNull")
private ExternalId _underlyingId;
/**
* The exercise type.
*/
@PropertyDefinition(validate = "notNull")
private ExerciseType _exerciseType;
/**
* The expiry.
*/
@PropertyDefinition(validate = "notNull")
private Expiry _expiry;
/**
* The underlying shares.
*/
@PropertyDefinition
private double _underlyingShares;
/**
* The exchange.
*/
@PropertyDefinition(validate = "notNull")
private String _exchange;
/**
* For the builder.
*/
/* package */ EquityWarrantSecurity() {
super(SECURITY_TYPE);
}
/**
* @param optionType The warrant type, not null.
* @param strike The strike
* @param currency The currency, not null
* @param underlyingIdentifier The underlying identifier, not null
* @param exerciseType The exercise type, not null
* @param expiry The expiry, not null
* @param underlyingShares The number of underlying shares that the warrant exercises into
* @param exchange The exchange, not null
*/
public EquityWarrantSecurity(final OptionType optionType, final double strike, final Currency currency, final ExternalId underlyingIdentifier,
final ExerciseType exerciseType, final Expiry expiry, final double underlyingShares, final String exchange) {
super(SECURITY_TYPE);
setOptionType(optionType);
setStrike(strike);
setCurrency(currency);
setUnderlyingId(underlyingIdentifier);
setExerciseType(exerciseType);
setExpiry(expiry);
setUnderlyingShares(underlyingShares);
setExchange(exchange);
}
@Override
public <T> T accept(final FinancialSecurityVisitor<T> visitor) {
return visitor.visitEquityWarrantSecurity(this);
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code EquityWarrantSecurity}.
* @return the meta-bean, not null
*/
public static EquityWarrantSecurity.Meta meta() {
return EquityWarrantSecurity.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(EquityWarrantSecurity.Meta.INSTANCE);
}
@Override
public EquityWarrantSecurity.Meta metaBean() {
return EquityWarrantSecurity.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
/**
* Gets the option type.
* @return the value of the property, not null
*/
public OptionType getOptionType() {
return _optionType;
}
/**
* Sets the option type.
* @param optionType the new value of the property, not null
*/
public void setOptionType(OptionType optionType) {
JodaBeanUtils.notNull(optionType, "optionType");
this._optionType = optionType;
}
/**
* Gets the the {@code optionType} property.
* @return the property, not null
*/
public final Property<OptionType> optionType() {
return metaBean().optionType().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the strike.
* @return the value of the property
*/
public double getStrike() {
return _strike;
}
/**
* Sets the strike.
* @param strike the new value of the property
*/
public void setStrike(double strike) {
this._strike = strike;
}
/**
* Gets the the {@code strike} property.
* @return the property, not null
*/
public final Property<Double> strike() {
return metaBean().strike().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the currency.
* @return the value of the property, not null
*/
public Currency getCurrency() {
return _currency;
}
/**
* Sets the currency.
* @param currency the new value of the property, not null
*/
public void setCurrency(Currency currency) {
JodaBeanUtils.notNull(currency, "currency");
this._currency = currency;
}
/**
* Gets the the {@code currency} property.
* @return the property, not null
*/
public final Property<Currency> currency() {
return metaBean().currency().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the underlying identifier.
* @return the value of the property, not null
*/
public ExternalId getUnderlyingId() {
return _underlyingId;
}
/**
* Sets the underlying identifier.
* @param underlyingId the new value of the property, not null
*/
public void setUnderlyingId(ExternalId underlyingId) {
JodaBeanUtils.notNull(underlyingId, "underlyingId");
this._underlyingId = underlyingId;
}
/**
* Gets the the {@code underlyingId} property.
* @return the property, not null
*/
public final Property<ExternalId> underlyingId() {
return metaBean().underlyingId().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the exercise type.
* @return the value of the property, not null
*/
public ExerciseType getExerciseType() {
return _exerciseType;
}
/**
* Sets the exercise type.
* @param exerciseType the new value of the property, not null
*/
public void setExerciseType(ExerciseType exerciseType) {
JodaBeanUtils.notNull(exerciseType, "exerciseType");
this._exerciseType = exerciseType;
}
/**
* Gets the the {@code exerciseType} property.
* @return the property, not null
*/
public final Property<ExerciseType> exerciseType() {
return metaBean().exerciseType().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the expiry.
* @return the value of the property, not null
*/
public Expiry getExpiry() {
return _expiry;
}
/**
* Sets the expiry.
* @param expiry the new value of the property, not null
*/
public void setExpiry(Expiry expiry) {
JodaBeanUtils.notNull(expiry, "expiry");
this._expiry = expiry;
}
/**
* Gets the the {@code expiry} property.
* @return the property, not null
*/
public final Property<Expiry> expiry() {
return metaBean().expiry().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the underlying shares.
* @return the value of the property
*/
public double getUnderlyingShares() {
return _underlyingShares;
}
/**
* Sets the underlying shares.
* @param underlyingShares the new value of the property
*/
public void setUnderlyingShares(double underlyingShares) {
this._underlyingShares = underlyingShares;
}
/**
* Gets the the {@code underlyingShares} property.
* @return the property, not null
*/
public final Property<Double> underlyingShares() {
return metaBean().underlyingShares().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the exchange.
* @return the value of the property, not null
*/
public String getExchange() {
return _exchange;
}
/**
* Sets the exchange.
* @param exchange the new value of the property, not null
*/
public void setExchange(String exchange) {
JodaBeanUtils.notNull(exchange, "exchange");
this._exchange = exchange;
}
/**
* Gets the the {@code exchange} property.
* @return the property, not null
*/
public final Property<String> exchange() {
return metaBean().exchange().createProperty(this);
}
//-----------------------------------------------------------------------
@Override
public EquityWarrantSecurity clone() {
return JodaBeanUtils.cloneAlways(this);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
EquityWarrantSecurity other = (EquityWarrantSecurity) obj;
return JodaBeanUtils.equal(getOptionType(), other.getOptionType()) &&
JodaBeanUtils.equal(getStrike(), other.getStrike()) &&
JodaBeanUtils.equal(getCurrency(), other.getCurrency()) &&
JodaBeanUtils.equal(getUnderlyingId(), other.getUnderlyingId()) &&
JodaBeanUtils.equal(getExerciseType(), other.getExerciseType()) &&
JodaBeanUtils.equal(getExpiry(), other.getExpiry()) &&
JodaBeanUtils.equal(getUnderlyingShares(), other.getUnderlyingShares()) &&
JodaBeanUtils.equal(getExchange(), other.getExchange()) &&
super.equals(obj);
}
return false;
}
@Override
public int hashCode() {
int hash = 7;
hash = hash * 31 + JodaBeanUtils.hashCode(getOptionType());
hash = hash * 31 + JodaBeanUtils.hashCode(getStrike());
hash = hash * 31 + JodaBeanUtils.hashCode(getCurrency());
hash = hash * 31 + JodaBeanUtils.hashCode(getUnderlyingId());
hash = hash * 31 + JodaBeanUtils.hashCode(getExerciseType());
hash = hash * 31 + JodaBeanUtils.hashCode(getExpiry());
hash = hash * 31 + JodaBeanUtils.hashCode(getUnderlyingShares());
hash = hash * 31 + JodaBeanUtils.hashCode(getExchange());
return hash ^ super.hashCode();
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(288);
buf.append("EquityWarrantSecurity{");
int len = buf.length();
toString(buf);
if (buf.length() > len) {
buf.setLength(buf.length() - 2);
}
buf.append('}');
return buf.toString();
}
@Override
protected void toString(StringBuilder buf) {
super.toString(buf);
buf.append("optionType").append('=').append(JodaBeanUtils.toString(getOptionType())).append(',').append(' ');
buf.append("strike").append('=').append(JodaBeanUtils.toString(getStrike())).append(',').append(' ');
buf.append("currency").append('=').append(JodaBeanUtils.toString(getCurrency())).append(',').append(' ');
buf.append("underlyingId").append('=').append(JodaBeanUtils.toString(getUnderlyingId())).append(',').append(' ');
buf.append("exerciseType").append('=').append(JodaBeanUtils.toString(getExerciseType())).append(',').append(' ');
buf.append("expiry").append('=').append(JodaBeanUtils.toString(getExpiry())).append(',').append(' ');
buf.append("underlyingShares").append('=').append(JodaBeanUtils.toString(getUnderlyingShares())).append(',').append(' ');
buf.append("exchange").append('=').append(JodaBeanUtils.toString(getExchange())).append(',').append(' ');
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code EquityWarrantSecurity}.
*/
public static class Meta extends FinancialSecurity.Meta {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code optionType} property.
*/
private final MetaProperty<OptionType> _optionType = DirectMetaProperty.ofReadWrite(
this, "optionType", EquityWarrantSecurity.class, OptionType.class);
/**
* The meta-property for the {@code strike} property.
*/
private final MetaProperty<Double> _strike = DirectMetaProperty.ofReadWrite(
this, "strike", EquityWarrantSecurity.class, Double.TYPE);
/**
* The meta-property for the {@code currency} property.
*/
private final MetaProperty<Currency> _currency = DirectMetaProperty.ofReadWrite(
this, "currency", EquityWarrantSecurity.class, Currency.class);
/**
* The meta-property for the {@code underlyingId} property.
*/
private final MetaProperty<ExternalId> _underlyingId = DirectMetaProperty.ofReadWrite(
this, "underlyingId", EquityWarrantSecurity.class, ExternalId.class);
/**
* The meta-property for the {@code exerciseType} property.
*/
private final MetaProperty<ExerciseType> _exerciseType = DirectMetaProperty.ofReadWrite(
this, "exerciseType", EquityWarrantSecurity.class, ExerciseType.class);
/**
* The meta-property for the {@code expiry} property.
*/
private final MetaProperty<Expiry> _expiry = DirectMetaProperty.ofReadWrite(
this, "expiry", EquityWarrantSecurity.class, Expiry.class);
/**
* The meta-property for the {@code underlyingShares} property.
*/
private final MetaProperty<Double> _underlyingShares = DirectMetaProperty.ofReadWrite(
this, "underlyingShares", EquityWarrantSecurity.class, Double.TYPE);
/**
* The meta-property for the {@code exchange} property.
*/
private final MetaProperty<String> _exchange = DirectMetaProperty.ofReadWrite(
this, "exchange", EquityWarrantSecurity.class, String.class);
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> _metaPropertyMap$ = new DirectMetaPropertyMap(
this, (DirectMetaPropertyMap) super.metaPropertyMap(),
"optionType",
"strike",
"currency",
"underlyingId",
"exerciseType",
"expiry",
"underlyingShares",
"exchange");
/**
* Restricted constructor.
*/
protected Meta() {
}
@Override
protected MetaProperty<?> metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case 1373587791: // optionType
return _optionType;
case -891985998: // strike
return _strike;
case 575402001: // currency
return _currency;
case -771625640: // underlyingId
return _underlyingId;
case -466331342: // exerciseType
return _exerciseType;
case -1289159373: // expiry
return _expiry;
case 194127409: // underlyingShares
return _underlyingShares;
case 1989774883: // exchange
return _exchange;
}
return super.metaPropertyGet(propertyName);
}
@Override
public BeanBuilder<? extends EquityWarrantSecurity> builder() {
return new DirectBeanBuilder<EquityWarrantSecurity>(new EquityWarrantSecurity());
}
@Override
public Class<? extends EquityWarrantSecurity> beanType() {
return EquityWarrantSecurity.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return _metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code optionType} property.
* @return the meta-property, not null
*/
public final MetaProperty<OptionType> optionType() {
return _optionType;
}
/**
* The meta-property for the {@code strike} property.
* @return the meta-property, not null
*/
public final MetaProperty<Double> strike() {
return _strike;
}
/**
* The meta-property for the {@code currency} property.
* @return the meta-property, not null
*/
public final MetaProperty<Currency> currency() {
return _currency;
}
/**
* The meta-property for the {@code underlyingId} property.
* @return the meta-property, not null
*/
public final MetaProperty<ExternalId> underlyingId() {
return _underlyingId;
}
/**
* The meta-property for the {@code exerciseType} property.
* @return the meta-property, not null
*/
public final MetaProperty<ExerciseType> exerciseType() {
return _exerciseType;
}
/**
* The meta-property for the {@code expiry} property.
* @return the meta-property, not null
*/
public final MetaProperty<Expiry> expiry() {
return _expiry;
}
/**
* The meta-property for the {@code underlyingShares} property.
* @return the meta-property, not null
*/
public final MetaProperty<Double> underlyingShares() {
return _underlyingShares;
}
/**
* The meta-property for the {@code exchange} property.
* @return the meta-property, not null
*/
public final MetaProperty<String> exchange() {
return _exchange;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case 1373587791: // optionType
return ((EquityWarrantSecurity) bean).getOptionType();
case -891985998: // strike
return ((EquityWarrantSecurity) bean).getStrike();
case 575402001: // currency
return ((EquityWarrantSecurity) bean).getCurrency();
case -771625640: // underlyingId
return ((EquityWarrantSecurity) bean).getUnderlyingId();
case -466331342: // exerciseType
return ((EquityWarrantSecurity) bean).getExerciseType();
case -1289159373: // expiry
return ((EquityWarrantSecurity) bean).getExpiry();
case 194127409: // underlyingShares
return ((EquityWarrantSecurity) bean).getUnderlyingShares();
case 1989774883: // exchange
return ((EquityWarrantSecurity) bean).getExchange();
}
return super.propertyGet(bean, propertyName, quiet);
}
@Override
protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) {
switch (propertyName.hashCode()) {
case 1373587791: // optionType
((EquityWarrantSecurity) bean).setOptionType((OptionType) newValue);
return;
case -891985998: // strike
((EquityWarrantSecurity) bean).setStrike((Double) newValue);
return;
case 575402001: // currency
((EquityWarrantSecurity) bean).setCurrency((Currency) newValue);
return;
case -771625640: // underlyingId
((EquityWarrantSecurity) bean).setUnderlyingId((ExternalId) newValue);
return;
case -466331342: // exerciseType
((EquityWarrantSecurity) bean).setExerciseType((ExerciseType) newValue);
return;
case -1289159373: // expiry
((EquityWarrantSecurity) bean).setExpiry((Expiry) newValue);
return;
case 194127409: // underlyingShares
((EquityWarrantSecurity) bean).setUnderlyingShares((Double) newValue);
return;
case 1989774883: // exchange
((EquityWarrantSecurity) bean).setExchange((String) newValue);
return;
}
super.propertySet(bean, propertyName, newValue, quiet);
}
@Override
protected void validate(Bean bean) {
JodaBeanUtils.notNull(((EquityWarrantSecurity) bean)._optionType, "optionType");
JodaBeanUtils.notNull(((EquityWarrantSecurity) bean)._currency, "currency");
JodaBeanUtils.notNull(((EquityWarrantSecurity) bean)._underlyingId, "underlyingId");
JodaBeanUtils.notNull(((EquityWarrantSecurity) bean)._exerciseType, "exerciseType");
JodaBeanUtils.notNull(((EquityWarrantSecurity) bean)._expiry, "expiry");
JodaBeanUtils.notNull(((EquityWarrantSecurity) bean)._exchange, "exchange");
super.validate(bean);
}
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}