Package com.opengamma.strata.product

Class PositionInfo

  • All Implemented Interfaces:
    Attributes, PortfolioItemInfo, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean
    public final class PositionInfo
extends Object
implements PortfolioItemInfo, org.joda.beans.ImmutableBean, Serializable
    Additional information about a position.

    This allows additional information about a position to be associated. It is kept in a separate object as the information is optional for pricing.

    See Also:
    Serialized Form

    • Method Detail

      • empty

        public static PositionInfo empty()
        Obtains an empty instance, with no identifier or attributes.
        Returns:
        the empty instance

      • of

        public static PositionInfo of​(StandardId positionId)
        Obtains an instance with the specified position identifier.
        Parameters:
        positionId - the position identifier
        Returns:
        the position information

      • from

        public static PositionInfo from​(PortfolioItemInfo info)
        Obtains an instance based on the supplied info.
        Parameters:
        info - the base info
        Returns:
        the position information

      • builder

        public static PositionInfoBuilder builder()
        Returns a builder used to create an instance of the bean.
        Returns:
        the builder

      • withId

        public PositionInfo withId​(StandardId identifier)
        Description copied from interface: PortfolioItemInfo
        Returns a copy of this instance with the identifier changed.

        This returns a new instance with the identifier changed. If the specified identifier is null, the existing identifier will be removed. If the specified identifier is non-null, it will become the identifier of the resulting info.

        Specified by:
        withId in interface PortfolioItemInfo
        Parameters:
        identifier - the identifier to set
        Returns:
        a new instance based on this one with the identifier set

      • findAttribute

        public <T> Optional<T> findAttribute​(AttributeType<T> type)
        Description copied from interface: Attributes
        Finds the attribute associated with the specified type.

        This method obtains the specified attribute. This allows an attribute to be obtained if available.

        If the attribute is not found, optional empty is returned.

        Specified by:
        findAttribute in interface Attributes
        Type Parameters:
        T - the type of the result
        Parameters:
        type - the type to find
        Returns:
        the attribute value

      • withAttribute

        public <T> PositionInfo withAttribute​(AttributeType<T> type,
                                      T value)
        Description copied from interface: Attributes
        Returns a copy of this instance with the attribute added.

        This returns a new instance with the specified attribute added. The attribute is added using Map.put(type, value) semantics.

        Specified by:
        withAttribute in interface Attributes
        Specified by:
        withAttribute in interface PortfolioItemInfo
        Type Parameters:
        T - the type of the attribute value
        Parameters:
        type - the type providing meaning to the value
        value - the value
        Returns:
        a new instance based on this one with the attribute added

      • withAttributes

        public PositionInfo withAttributes​(Attributes other)
        Description copied from interface: Attributes
        Returns a copy of this instance with the attributes added.

        This returns a new instance with the specified attributes added. The attributes are added using Map.putAll(type, value) semantics.

        Specified by:
        withAttributes in interface Attributes
        Specified by:
        withAttributes in interface PortfolioItemInfo
        Parameters:
        other - the other instance to copy from
        Returns:
        an instance based on this one with the attributes from the other instance

      • combinedWith

        public PositionInfo combinedWith​(PortfolioItemInfo other)
        Description copied from interface: PortfolioItemInfo
        Combines this info with another.

        If there is a conflict, data from this instance takes precedence. If the other instance is not of the same type, data may be lost.

        Specified by:
        combinedWith in interface PortfolioItemInfo
        Parameters:
        other - the other instance
        Returns:
        the combined instance

      • overrideWith

        public PositionInfo overrideWith​(PortfolioItemInfo other)
        Description copied from interface: PortfolioItemInfo
        Overrides attributes of this info with another.

        If there is a conflict, data from the other instance takes precedence. If the other instance is not of the same type, data may be lost.

        Specified by:
        overrideWith in interface PortfolioItemInfo
        Parameters:
        other - the other instance
        Returns:
        the combined instance

      • toBuilder

        public PositionInfoBuilder toBuilder()
        Returns a builder populated with the values of this instance.
        Returns:
        a builder populated with the values of this instance

      • meta

        public static PositionInfo.Meta meta()
        The meta-bean for PositionInfo.
        Returns:
        the meta-bean, not null

      • metaBean

        public PositionInfo.Meta metaBean()
        Specified by:
        metaBean in interface org.joda.beans.Bean

      • getId

        public Optional<StandardId> getId()
        Gets the primary identifier for the position, optional.

        The identifier is used to identify the position. It will typically be an identifier in an external data system.

        A position may have multiple active identifiers. Any identifier may be chosen here. Certain uses of the identifier, such as storage in a database, require that the identifier does not change over time, and this should be considered best practice.

        Specified by:
        getId in interface PortfolioItemInfo
        Returns:
        the optional value of the property, not null

      • getAttributes

        public ImmutableMap<AttributeType<?>,​Object> getAttributes()
        Gets the position attributes.

        Position attributes provide the ability to associate arbitrary information in a key-value map.

        Returns:
        the value of the property, not null

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object