Class IborCapFloorTrade

    • Method Detail

      • resolve

        public ResolvedIborCapFloorTrade 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<ResolvedIborCapFloorTrade>
        Specified by:
        resolve in interface ResolvableTrade<ResolvedIborCapFloorTrade>
        Parameters:
        refData - the reference data to use when resolving
        Returns:
        the resolved trade
      • meta

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

        public static IborCapFloorTrade.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
      • getProduct

        public IborCapFloor getProduct()
        Gets the cap/floor product that was agreed when the trade occurred.

        The product captures the contracted financial details of the trade.

        Specified by:
        getProduct in interface ProductTrade
        Returns:
        the value of the property, not null
      • getPremium

        public java.util.Optional<AdjustablePayment> getPremium()
        Gets the optional premium of the product.

        For most Ibor cap/floor products, a premium is paid upfront. This typically occurs instead of periodic payments based on fixed or Ibor rates over the lifetime of the product.

        The premium sign must be compatible with the product Pay/Receive flag.

        Returns:
        the optional value of the property, not null
      • toBuilder

        public IborCapFloorTrade.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