com.opengamma.strata.product.Position Maven / Gradle / Ivy
/*
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.product;
import com.opengamma.strata.product.common.SummarizerUtils;
/**
* A position in a security.
*
* This is used to represent the total quantity of a {@link Security}.
* A position is effectively the sum of one or more trades.
*
* Implementations of this interface must be immutable beans.
*/
public interface Position
extends PortfolioItem, SecurityQuantity {
@Override
public default PortfolioItemSummary summarize() {
// AAPL x 200
String description = getSecurityId().getStandardId().getValue() + " x " + SummarizerUtils.value(getQuantity());
return SummarizerUtils.summary(this, ProductType.SECURITY, description);
}
/**
* Gets the standard position information.
*
* All positions contain this standard set of information.
* It includes the identifier and an extensible data map.
*
* @return the position information
*/
@Override
public abstract PositionInfo getInfo();
/**
* Gets the identifier of the underlying security.
*
* This identifier uniquely identifies the security within the system.
*
* @return the security identifier
*/
@Override
public abstract SecurityId getSecurityId();
/**
* 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.
*
* @return the net quantity of the underlying security
*/
@Override
public abstract double getQuantity();
//-------------------------------------------------------------------------
/**
* Returns an instance with the specified info.
*
* @param info the new info
* @return the instance with the specified info
*/
@Override
public abstract Position withInfo(PortfolioItemInfo info);
/**
* Returns an instance with the specified quantity.
*
* @param quantity the new quantity
* @return the instance with the specified quantity
*/
public abstract Position withQuantity(double quantity);
}