com.opengamma.strata.product.SecurityPosition 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.DerivedProperty;
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.ReferenceData;
import com.opengamma.strata.collect.ArgChecker;
import com.opengamma.strata.collect.Messages;
/**
* A position in a security, where the security is referenced by identifier.
*
* This represents a position in a security, defined by long and short quantity.
* The security is referenced using {@link SecurityId}.
* The identifier may be looked up in {@link ReferenceData}.
*
* The net quantity of the position is stored using two fields - {@code longQuantity} and {@code shortQuantity}.
* These two fields must not be negative.
* In many cases, only a long quantity or short quantity will be present with the other set to zero.
* However it is also possible for both to be non-zero, allowing long and short positions to be treated separately.
* The net quantity is available via {@link #getQuantity()}.
*/
@BeanDefinition(constructorScope = "package")
public final class SecurityPosition
implements ResolvableSecurityPosition, ImmutableBean, Serializable {
/**
* The additional position information, defaulted to an empty instance.
*
* This allows additional information to be attached to the position.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final PositionInfo info;
/**
* The identifier of the underlying security.
*
* This identifier uniquely identifies the security within the system.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final SecurityId securityId;
/**
* The long quantity of the security.
*
* This is the quantity of the underlying security that is held.
* The quantity cannot be negative, as that would imply short selling.
*/
@PropertyDefinition(validate = "ArgChecker.notNegative")
private final double longQuantity;
/**
* The quantity that was traded.
*
* This is the quantity of the underlying security that has been short sold.
* The quantity cannot be negative, as that would imply the position is long.
*/
@PropertyDefinition(validate = "ArgChecker.notNegative")
private final double shortQuantity;
//-------------------------------------------------------------------------
/**
* Obtains an instance from the security identifier and net quantity.
*
* The net quantity is the long quantity minus the short quantity, which may be negative.
* If the quantity is positive it is treated as a long quantity.
* Otherwise it is treated as a short quantity.
*
* @param securityId the identifier of the underlying security
* @param netQuantity the net quantity of the underlying security
* @return the position
*/
public static SecurityPosition ofNet(SecurityId securityId, double netQuantity) {
return ofNet(PositionInfo.empty(), securityId, netQuantity);
}
/**
* Obtains an instance from position information, security identifier and net quantity.
*
* The net quantity is the long quantity minus the short quantity, which may be negative.
* If the quantity is positive it is treated as a long quantity.
* Otherwise it is treated as a short quantity.
*
* @param positionInfo the position information
* @param securityId the identifier of the underlying security
* @param netQuantity the net quantity of the underlying security
* @return the position
*/
public static SecurityPosition ofNet(PositionInfo positionInfo, SecurityId securityId, double netQuantity) {
double longQuantity = netQuantity >= 0 ? netQuantity : 0;
double shortQuantity = netQuantity >= 0 ? 0 : -netQuantity;
return new SecurityPosition(positionInfo, securityId, longQuantity, shortQuantity);
}
/**
* Obtains an instance from the security identifier, long quantity and short quantity.
*
* The long quantity and short quantity must be zero or positive, not negative.
* In many cases, only a long quantity or short quantity will be present with the other set to zero.
* However it is also possible for both to be non-zero, allowing long and short positions to be treated separately.
*
* @param securityId the identifier of the underlying security
* @param longQuantity the long quantity of the underlying security
* @param shortQuantity the short quantity of the underlying security
* @return the position
*/
public static SecurityPosition ofLongShort(SecurityId securityId, double longQuantity, double shortQuantity) {
return ofLongShort(PositionInfo.empty(), securityId, longQuantity, shortQuantity);
}
/**
* Obtains an instance from position information, security identifier, long quantity and short quantity.
*
* The long quantity and short quantity must be zero or positive, not negative.
* In many cases, only a long quantity or short quantity will be present with the other set to zero.
* However it is also possible for both to be non-zero, allowing long and short positions to be treated separately.
*
* @param positionInfo the position information
* @param securityId the identifier of the underlying security
* @param longQuantity the long quantity of the underlying security
* @param shortQuantity the short quantity of the underlying security
* @return the position
*/
public static SecurityPosition ofLongShort(
PositionInfo positionInfo,
SecurityId securityId,
double longQuantity,
double shortQuantity) {
return new SecurityPosition(positionInfo, securityId, longQuantity, shortQuantity);
}
@ImmutableDefaults
private static void applyDefaults(Builder builder) {
builder.info = PositionInfo.empty();
}
//-------------------------------------------------------------------------
/**
* Gets the net quantity of the security.
*
* This returns the net quantity of the underlying security.
* The result is positive if the net position is long and negative
* if the net position is short.
*
* This is calculated by subtracting the short quantity from the long quantity.
*
* @return the net quantity of the underlying security
*/
@Override
@DerivedProperty
public double getQuantity() {
return longQuantity - shortQuantity;
}
//-------------------------------------------------------------------------
@Override
public SecurityPosition withInfo(PortfolioItemInfo info) {
return new SecurityPosition(PositionInfo.from(info), securityId, longQuantity, shortQuantity);
}
@Override
public SecurityPosition withQuantity(double quantity) {
return SecurityPosition.ofNet(info, securityId, quantity);
}
@Override
public SecuritizedProductPosition resolveTarget(ReferenceData refData) {
SecurityId securityId = getSecurityId();
Security security = refData.getValue(securityId);
Position position = security.createPosition(getInfo(), getLongQuantity(), getShortQuantity(), refData);
if (position instanceof SecuritizedProductPosition) {
return (SecuritizedProductPosition) position;
}
throw new ClassCastException(Messages.format(
"Reference data for security '{}' did not implement SecuritizedProductPosition: ",
securityId,
position.getClass().getName()));
}
//------------------------- AUTOGENERATED START -------------------------
/**
* The meta-bean for {@code SecurityPosition}.
* @return the meta-bean, not null
*/
public static SecurityPosition.Meta meta() {
return SecurityPosition.Meta.INSTANCE;
}
static {
MetaBean.register(SecurityPosition.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 SecurityPosition.Builder builder() {
return new SecurityPosition.Builder();
}
/**
* Creates an instance.
* @param info the value of the property, not null
* @param securityId the value of the property, not null
* @param longQuantity the value of the property
* @param shortQuantity the value of the property
*/
SecurityPosition(
PositionInfo info,
SecurityId securityId,
double longQuantity,
double shortQuantity) {
JodaBeanUtils.notNull(info, "info");
JodaBeanUtils.notNull(securityId, "securityId");
ArgChecker.notNegative(longQuantity, "longQuantity");
ArgChecker.notNegative(shortQuantity, "shortQuantity");
this.info = info;
this.securityId = securityId;
this.longQuantity = longQuantity;
this.shortQuantity = shortQuantity;
}
@Override
public SecurityPosition.Meta metaBean() {
return SecurityPosition.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
/**
* Gets the additional position information, defaulted to an empty instance.
*
* This allows additional information to be attached to the position.
* @return the value of the property, not null
*/
@Override
public PositionInfo getInfo() {
return info;
}
//-----------------------------------------------------------------------
/**
* Gets the identifier of the underlying security.
*
* This identifier uniquely identifies the security within the system.
* @return the value of the property, not null
*/
@Override
public SecurityId getSecurityId() {
return securityId;
}
//-----------------------------------------------------------------------
/**
* Gets the long quantity of the security.
*
* This is the quantity of the underlying security that is held.
* The quantity cannot be negative, as that would imply short selling.
* @return the value of the property
*/
public double getLongQuantity() {
return longQuantity;
}
//-----------------------------------------------------------------------
/**
* Gets the quantity that was traded.
*
* This is the quantity of the underlying security that has been short sold.
* The quantity cannot be negative, as that would imply the position is long.
* @return the value of the property
*/
public double getShortQuantity() {
return shortQuantity;
}
//-----------------------------------------------------------------------
/**
* 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()) {
SecurityPosition other = (SecurityPosition) obj;
return JodaBeanUtils.equal(info, other.info) &&
JodaBeanUtils.equal(securityId, other.securityId) &&
JodaBeanUtils.equal(longQuantity, other.longQuantity) &&
JodaBeanUtils.equal(shortQuantity, other.shortQuantity);
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(info);
hash = hash * 31 + JodaBeanUtils.hashCode(securityId);
hash = hash * 31 + JodaBeanUtils.hashCode(longQuantity);
hash = hash * 31 + JodaBeanUtils.hashCode(shortQuantity);
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(192);
buf.append("SecurityPosition{");
buf.append("info").append('=').append(JodaBeanUtils.toString(info)).append(',').append(' ');
buf.append("securityId").append('=').append(JodaBeanUtils.toString(securityId)).append(',').append(' ');
buf.append("longQuantity").append('=').append(JodaBeanUtils.toString(longQuantity)).append(',').append(' ');
buf.append("shortQuantity").append('=').append(JodaBeanUtils.toString(shortQuantity)).append(',').append(' ');
buf.append("quantity").append('=').append(JodaBeanUtils.toString(getQuantity()));
buf.append('}');
return buf.toString();
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code SecurityPosition}.
*/
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", SecurityPosition.class, PositionInfo.class);
/**
* The meta-property for the {@code securityId} property.
*/
private final MetaProperty securityId = DirectMetaProperty.ofImmutable(
this, "securityId", SecurityPosition.class, SecurityId.class);
/**
* The meta-property for the {@code longQuantity} property.
*/
private final MetaProperty longQuantity = DirectMetaProperty.ofImmutable(
this, "longQuantity", SecurityPosition.class, Double.TYPE);
/**
* The meta-property for the {@code shortQuantity} property.
*/
private final MetaProperty shortQuantity = DirectMetaProperty.ofImmutable(
this, "shortQuantity", SecurityPosition.class, Double.TYPE);
/**
* The meta-property for the {@code quantity} property.
*/
private final MetaProperty quantity = DirectMetaProperty.ofDerived(
this, "quantity", SecurityPosition.class, Double.TYPE);
/**
* The meta-properties.
*/
private final Map> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"info",
"securityId",
"longQuantity",
"shortQuantity",
"quantity");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case 3237038: // info
return info;
case 1574023291: // securityId
return securityId;
case 611668775: // longQuantity
return longQuantity;
case -2094395097: // shortQuantity
return shortQuantity;
case -1285004149: // quantity
return quantity;
}
return super.metaPropertyGet(propertyName);
}
@Override
public SecurityPosition.Builder builder() {
return new SecurityPosition.Builder();
}
@Override
public Class beanType() {
return SecurityPosition.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 securityId} property.
* @return the meta-property, not null
*/
public MetaProperty securityId() {
return securityId;
}
/**
* The meta-property for the {@code longQuantity} property.
* @return the meta-property, not null
*/
public MetaProperty longQuantity() {
return longQuantity;
}
/**
* The meta-property for the {@code shortQuantity} property.
* @return the meta-property, not null
*/
public MetaProperty shortQuantity() {
return shortQuantity;
}
/**
* The meta-property for the {@code quantity} property.
* @return the meta-property, not null
*/
public MetaProperty quantity() {
return quantity;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case 3237038: // info
return ((SecurityPosition) bean).getInfo();
case 1574023291: // securityId
return ((SecurityPosition) bean).getSecurityId();
case 611668775: // longQuantity
return ((SecurityPosition) bean).getLongQuantity();
case -2094395097: // shortQuantity
return ((SecurityPosition) bean).getShortQuantity();
case -1285004149: // quantity
return ((SecurityPosition) bean).getQuantity();
}
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 SecurityPosition}.
*/
public static final class Builder extends DirectFieldsBeanBuilder {
private PositionInfo info;
private SecurityId securityId;
private double longQuantity;
private double shortQuantity;
/**
* Restricted constructor.
*/
private Builder() {
applyDefaults(this);
}
/**
* Restricted copy constructor.
* @param beanToCopy the bean to copy from, not null
*/
private Builder(SecurityPosition beanToCopy) {
this.info = beanToCopy.getInfo();
this.securityId = beanToCopy.getSecurityId();
this.longQuantity = beanToCopy.getLongQuantity();
this.shortQuantity = beanToCopy.getShortQuantity();
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case 3237038: // info
return info;
case 1574023291: // securityId
return securityId;
case 611668775: // longQuantity
return longQuantity;
case -2094395097: // shortQuantity
return shortQuantity;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case 3237038: // info
this.info = (PositionInfo) newValue;
break;
case 1574023291: // securityId
this.securityId = (SecurityId) newValue;
break;
case 611668775: // longQuantity
this.longQuantity = (Double) newValue;
break;
case -2094395097: // shortQuantity
this.shortQuantity = (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 SecurityPosition build() {
return new SecurityPosition(
info,
securityId,
longQuantity,
shortQuantity);
}
//-----------------------------------------------------------------------
/**
* Sets the additional position information, defaulted to an empty instance.
*
* This allows additional information to be attached to the position.
* @param info the new value, not null
* @return this, for chaining, not null
*/
public Builder info(PositionInfo info) {
JodaBeanUtils.notNull(info, "info");
this.info = info;
return this;
}
/**
* Sets the identifier of the underlying security.
*
* This identifier uniquely identifies the security within the system.
* @param securityId the new value, not null
* @return this, for chaining, not null
*/
public Builder securityId(SecurityId securityId) {
JodaBeanUtils.notNull(securityId, "securityId");
this.securityId = securityId;
return this;
}
/**
* Sets the long quantity of the security.
*
* This is the quantity of the underlying security that is held.
* The quantity cannot be negative, as that would imply short selling.
* @param longQuantity the new value
* @return this, for chaining, not null
*/
public Builder longQuantity(double longQuantity) {
ArgChecker.notNegative(longQuantity, "longQuantity");
this.longQuantity = longQuantity;
return this;
}
/**
* Sets the quantity that was traded.
*
* This is the quantity of the underlying security that has been short sold.
* The quantity cannot be negative, as that would imply the position is long.
* @param shortQuantity the new value
* @return this, for chaining, not null
*/
public Builder shortQuantity(double shortQuantity) {
ArgChecker.notNegative(shortQuantity, "shortQuantity");
this.shortQuantity = shortQuantity;
return this;
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(192);
buf.append("SecurityPosition.Builder{");
buf.append("info").append('=').append(JodaBeanUtils.toString(info)).append(',').append(' ');
buf.append("securityId").append('=').append(JodaBeanUtils.toString(securityId)).append(',').append(' ');
buf.append("longQuantity").append('=').append(JodaBeanUtils.toString(longQuantity)).append(',').append(' ');
buf.append("shortQuantity").append('=').append(JodaBeanUtils.toString(shortQuantity)).append(',').append(' ');
buf.append("quantity").append('=').append(JodaBeanUtils.toString(null));
buf.append('}');
return buf.toString();
}
}
//-------------------------- AUTOGENERATED END --------------------------
}