Class BillTrade

    • Method Detail

      • ofYield

        public static BillTrade ofYield​(TradeInfo info,
                                        Bill product,
                                        double quantity,
                                        double yield)
        Generates a Bill trade instance where the price is computed from the traded yield.
        Parameters:
        info - the additional trade information
        product - the bill that was traded
        quantity - the quantity that was traded
        yield - the yield at which the bill was traded
        Returns:
        the instance
      • ofPrice

        public static BillTrade ofPrice​(TradeInfo info,
                                        Bill product,
                                        double quantity,
                                        double price)
        Generates a Bill trade instance from the price.
        Parameters:
        info - the additional trade information
        product - the bill that was traded
        quantity - the quantity that was traded
        price - the price at which the bill was traded
        Returns:
        the instance
      • resolve

        public ResolvedBillTrade resolve​(ReferenceData refData)
        Description copied from interface: ResolvableTrade
        Resolves this trade using the specified reference data.

        This converts this trade to the equivalent resolved form. All ReferenceDataId identifiers in this instance will be resolved. The resulting ResolvedTrade is optimized for pricing.

        Resolved objects may be bound to data that changes over time, such as holiday calendars. If the data changes, such as the addition of a new holiday, the resolved form will not be updated. Care must be taken when placing the resolved form in a cache or persistence layer.

        Specified by:
        resolve in interface Resolvable<ResolvedBillTrade>
        Specified by:
        resolve in interface ResolvableTrade<ResolvedBillTrade>
        Parameters:
        refData - the reference data to use when resolving
        Returns:
        the resolved trade
      • meta

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

        public static BillTrade.Builder builder()
        Returns a builder used to create an instance of the bean.
        Returns:
        the builder, not null
      • getInfo

        public TradeInfo getInfo()
        Gets the additional trade information, defaulted to an empty instance.

        This allows additional information to be attached to the trade.

        Specified by:
        getInfo in interface PortfolioItem
        Specified by:
        getInfo in interface Trade
        Returns:
        the value of the property, not null
      • getQuantity

        public double getQuantity()
        Gets the quantity that was traded.

        This will be positive if buying and negative if selling.

        Specified by:
        getQuantity in interface SecurityQuantity
        Returns:
        the value of the property
      • getPrice

        public double getPrice()
        Gets the price at which the bill was traded, in decimal form.
        Specified by:
        getPrice in interface SecurityQuantityTrade
        Returns:
        the value of the property
      • toBuilder

        public BillTrade.Builder toBuilder()
        Returns a builder that allows this bean to be mutated.
        Returns:
        the mutable builder, not null
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object