com.opengamma.strata.product.GenericSecurityTrade Maven / Gradle / Ivy
Show all versions of strata-product Show documentation
/*
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.product;
import java.io.Serializable;
import java.util.Map;
import java.util.NoSuchElementException;
import org.joda.beans.Bean;
import org.joda.beans.ImmutableBean;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaBean;
import org.joda.beans.MetaProperty;
import org.joda.beans.gen.BeanDefinition;
import org.joda.beans.gen.ImmutableDefaults;
import org.joda.beans.gen.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;
import com.opengamma.strata.product.common.SummarizerUtils;
/**
* A trade representing the purchase or sale of a security,
* where the security is embedded ready for mark-to-market pricing.
*
* This trade represents a trade in a security, defined by a quantity and price.
* The security is embedded directly, however the underlying product model is not available.
* The security may be of any kind, including equities, bonds and exchange traded derivatives (ETD).
*/
@BeanDefinition(constructorScope = "package")
public final class GenericSecurityTrade
implements SecuritizedProductTrade, ImmutableBean, Serializable {
/**
* The additional trade information, defaulted to an empty instance.
*
* This allows additional information to be attached to the trade.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final TradeInfo info;
/**
* The security that was traded.
*/
@PropertyDefinition(validate = "notNull")
private final GenericSecurity security;
/**
* The quantity that was traded.
*
* This is the number of contracts that were traded.
* This will be positive if buying and negative if selling.
*/
@PropertyDefinition(overrideGet = true)
private final double quantity;
/**
* The price that was traded, in decimal form.
*
* This is the price agreed when the trade occurred.
*/
@PropertyDefinition(overrideGet = true)
private final double price;
//-------------------------------------------------------------------------
/**
* Obtains an instance from trade information, security, quantity and price.
*
* @param tradeInfo the trade information
* @param security the security that was traded
* @param quantity the quantity that was traded
* @param price the price that was traded
* @return the trade
*/
public static GenericSecurityTrade of(
TradeInfo tradeInfo,
GenericSecurity security,
double quantity,
double price) {
return new GenericSecurityTrade(tradeInfo, security, quantity, price);
}
@ImmutableDefaults
private static void applyDefaults(Builder builder) {
builder.info = TradeInfo.empty();
}
//-------------------------------------------------------------------------
@Override
public PortfolioItemSummary summarize() {
// AAPL x 200
String description = getSecurityId().getStandardId().getValue() + " x " + SummarizerUtils.value(getQuantity());
return SummarizerUtils.summary(this, ProductType.SECURITY, description, getCurrency());
}
@Override
public SecurityId getSecurityId() {
return security.getSecurityId();
}
@Override
public GenericSecurity getProduct() {
return security;
}
//-------------------------------------------------------------------------
@Override
public GenericSecurityTrade withInfo(PortfolioItemInfo info) {
return new GenericSecurityTrade(TradeInfo.from(info), security, quantity, price);
}
@Override
public GenericSecurityTrade withQuantity(double quantity) {
return new GenericSecurityTrade(info, security, quantity, price);
}
@Override
public GenericSecurityTrade withPrice(double price) {
return new GenericSecurityTrade(info, security, quantity, price);
}
/**
* Gets the currency of the trade.
*
* This is typically the same as the currency of the product.
*
* @return the trading currency
*/
@Override
public Currency getCurrency() {
return security.getCurrency();
}
//------------------------- AUTOGENERATED START -------------------------
/**
* The meta-bean for {@code GenericSecurityTrade}.
* @return the meta-bean, not null
*/
public static GenericSecurityTrade.Meta meta() {
return GenericSecurityTrade.Meta.INSTANCE;
}
static {
MetaBean.register(GenericSecurityTrade.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 GenericSecurityTrade.Builder builder() {
return new GenericSecurityTrade.Builder();
}
/**
* Creates an instance.
* @param info the value of the property, not null
* @param security the value of the property, not null
* @param quantity the value of the property
* @param price the value of the property
*/
GenericSecurityTrade(
TradeInfo info,
GenericSecurity security,
double quantity,
double price) {
JodaBeanUtils.notNull(info, "info");
JodaBeanUtils.notNull(security, "security");
this.info = info;
this.security = security;
this.quantity = quantity;
this.price = price;
}
@Override
public GenericSecurityTrade.Meta metaBean() {
return GenericSecurityTrade.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
/**
* Gets the additional trade information, defaulted to an empty instance.
*
* This allows additional information to be attached to the trade.
* @return the value of the property, not null
*/
@Override
public TradeInfo getInfo() {
return info;
}
//-----------------------------------------------------------------------
/**
* Gets the security that was traded.
* @return the value of the property, not null
*/
public GenericSecurity getSecurity() {
return security;
}
//-----------------------------------------------------------------------
/**
* Gets the quantity that was traded.
*
* This is the number of contracts that were traded.
* This will be positive if buying and negative if selling.
* @return the value of the property
*/
@Override
public double getQuantity() {
return quantity;
}
//-----------------------------------------------------------------------
/**
* Gets the price that was traded, in decimal form.
*
* This is the price agreed when the trade occurred.
* @return the value of the property
*/
@Override
public double getPrice() {
return price;
}
//-----------------------------------------------------------------------
/**
* 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()) {
GenericSecurityTrade other = (GenericSecurityTrade) obj;
return JodaBeanUtils.equal(info, other.info) &&
JodaBeanUtils.equal(security, other.security) &&
JodaBeanUtils.equal(quantity, other.quantity) &&
JodaBeanUtils.equal(price, other.price);
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(info);
hash = hash * 31 + JodaBeanUtils.hashCode(security);
hash = hash * 31 + JodaBeanUtils.hashCode(quantity);
hash = hash * 31 + JodaBeanUtils.hashCode(price);
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(160);
buf.append("GenericSecurityTrade{");
buf.append("info").append('=').append(JodaBeanUtils.toString(info)).append(',').append(' ');
buf.append("security").append('=').append(JodaBeanUtils.toString(security)).append(',').append(' ');
buf.append("quantity").append('=').append(JodaBeanUtils.toString(quantity)).append(',').append(' ');
buf.append("price").append('=').append(JodaBeanUtils.toString(price));
buf.append('}');
return buf.toString();
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code GenericSecurityTrade}.
*/
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 info} property.
*/
private final MetaProperty info = DirectMetaProperty.ofImmutable(
this, "info", GenericSecurityTrade.class, TradeInfo.class);
/**
* The meta-property for the {@code security} property.
*/
private final MetaProperty security = DirectMetaProperty.ofImmutable(
this, "security", GenericSecurityTrade.class, GenericSecurity.class);
/**
* The meta-property for the {@code quantity} property.
*/
private final MetaProperty quantity = DirectMetaProperty.ofImmutable(
this, "quantity", GenericSecurityTrade.class, Double.TYPE);
/**
* The meta-property for the {@code price} property.
*/
private final MetaProperty price = DirectMetaProperty.ofImmutable(
this, "price", GenericSecurityTrade.class, Double.TYPE);
/**
* The meta-properties.
*/
private final Map> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"info",
"security",
"quantity",
"price");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case 3237038: // info
return info;
case 949122880: // security
return security;
case -1285004149: // quantity
return quantity;
case 106934601: // price
return price;
}
return super.metaPropertyGet(propertyName);
}
@Override
public GenericSecurityTrade.Builder builder() {
return new GenericSecurityTrade.Builder();
}
@Override
public Class beanType() {
return GenericSecurityTrade.class;
}
@Override
public Map> metaPropertyMap() {
return metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code info} property.
* @return the meta-property, not null
*/
public MetaProperty info() {
return info;
}
/**
* The meta-property for the {@code security} property.
* @return the meta-property, not null
*/
public MetaProperty security() {
return security;
}
/**
* The meta-property for the {@code quantity} property.
* @return the meta-property, not null
*/
public MetaProperty quantity() {
return quantity;
}
/**
* The meta-property for the {@code price} property.
* @return the meta-property, not null
*/
public MetaProperty price() {
return price;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case 3237038: // info
return ((GenericSecurityTrade) bean).getInfo();
case 949122880: // security
return ((GenericSecurityTrade) bean).getSecurity();
case -1285004149: // quantity
return ((GenericSecurityTrade) bean).getQuantity();
case 106934601: // price
return ((GenericSecurityTrade) bean).getPrice();
}
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 GenericSecurityTrade}.
*/
public static final class Builder extends DirectFieldsBeanBuilder {
private TradeInfo info;
private GenericSecurity security;
private double quantity;
private double price;
/**
* Restricted constructor.
*/
private Builder() {
applyDefaults(this);
}
/**
* Restricted copy constructor.
* @param beanToCopy the bean to copy from, not null
*/
private Builder(GenericSecurityTrade beanToCopy) {
this.info = beanToCopy.getInfo();
this.security = beanToCopy.getSecurity();
this.quantity = beanToCopy.getQuantity();
this.price = beanToCopy.getPrice();
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case 3237038: // info
return info;
case 949122880: // security
return security;
case -1285004149: // quantity
return quantity;
case 106934601: // price
return price;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case 3237038: // info
this.info = (TradeInfo) newValue;
break;
case 949122880: // security
this.security = (GenericSecurity) newValue;
break;
case -1285004149: // quantity
this.quantity = (Double) newValue;
break;
case 106934601: // price
this.price = (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 GenericSecurityTrade build() {
return new GenericSecurityTrade(
info,
security,
quantity,
price);
}
//-----------------------------------------------------------------------
/**
* Sets the additional trade information, defaulted to an empty instance.
*
* This allows additional information to be attached to the trade.
* @param info the new value, not null
* @return this, for chaining, not null
*/
public Builder info(TradeInfo info) {
JodaBeanUtils.notNull(info, "info");
this.info = info;
return this;
}
/**
* Sets the security that was traded.
* @param security the new value, not null
* @return this, for chaining, not null
*/
public Builder security(GenericSecurity security) {
JodaBeanUtils.notNull(security, "security");
this.security = security;
return this;
}
/**
* Sets the quantity that was traded.
*
* This is the number of contracts that were traded.
* This will be positive if buying and negative if selling.
* @param quantity the new value
* @return this, for chaining, not null
*/
public Builder quantity(double quantity) {
this.quantity = quantity;
return this;
}
/**
* Sets the price that was traded, in decimal form.
*
* This is the price agreed when the trade occurred.
* @param price the new value
* @return this, for chaining, not null
*/
public Builder price(double price) {
this.price = price;
return this;
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(160);
buf.append("GenericSecurityTrade.Builder{");
buf.append("info").append('=').append(JodaBeanUtils.toString(info)).append(',').append(' ');
buf.append("security").append('=').append(JodaBeanUtils.toString(security)).append(',').append(' ');
buf.append("quantity").append('=').append(JodaBeanUtils.toString(quantity)).append(',').append(' ');
buf.append("price").append('=').append(JodaBeanUtils.toString(price));
buf.append('}');
return buf.toString();
}
}
//-------------------------- AUTOGENERATED END --------------------------
}