Class Bill

  • All Implemented Interfaces:
    Resolvable<ResolvedBill>, Product, SecuritizedProduct,, org.joda.beans.Bean, org.joda.beans.ImmutableBean

    public final class Bill
    extends java.lang.Object
    implements SecuritizedProduct, Resolvable<ResolvedBill>, org.joda.beans.ImmutableBean,
    A bill.

    A bill is a financial instrument that represents a unique fixed payment.

    Price and yield

    Strata uses decimal yields and prices for bills in the trade model, pricers and market data. For example, a price of 99.32% is represented in Strata by 0.9932 and a yield of 1.32% is represented by 0.0132.
    See Also:
    Serialized Form
    • Method Detail

      • priceFromYield

        public double priceFromYield​(double yield,
                                     java.time.LocalDate settlementDate)
        Computes the price from the yield at a given settlement date.
        yield - the yield
        settlementDate - the settlement date
        the price
      • yieldFromPrice

        public double yieldFromPrice​(double price,
                                     java.time.LocalDate settlementDate)
        Computes the yield from the price at a given settlement date.
        price - the price
        settlementDate - the settlement date
        the yield
      • resolve

        public ResolvedBill resolve​(ReferenceData refData)
        Description copied from interface: Resolvable
        Resolves this object using the specified reference data.

        This converts the object implementing this interface to the equivalent resolved form. All ReferenceDataId identifiers in this instance will be resolved. The resolved form will typically be a type that 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<ResolvedBill>
        refData - the reference data to use when resolving
        the resolved instance
      • meta

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

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

        public Bill.Meta metaBean()
        Specified by:
        metaBean in interface org.joda.beans.Bean
      • getSecurityId

        public SecurityId getSecurityId()
        Gets the security identifier.

        This identifier uniquely identifies the security within the system.

        Specified by:
        getSecurityId in interface SecuritizedProduct
        the value of the property, not null
      • getNotional

        public AdjustablePayment getNotional()
        Gets the adjustable notional payment of the bill notional, the amount must be positive.
        the value of the property, not null
      • getDayCount

        public DayCount getDayCount()
        Gets the day count convention applicable.

        The conversion from dates to a numerical value is made based on this day count.

        the value of the property, not null
      • getYieldConvention

        public BillYieldConvention getYieldConvention()
        Gets yield convention.

        The convention defines how to convert from yield to price and inversely.

        the value of the property, not null
      • getLegalEntityId

        public LegalEntityId getLegalEntityId()
        Gets the legal entity identifier.

        This identifier is used for the legal entity that issues the bill.

        the value of the property, not null
      • getSettlementDateOffset

        public DaysAdjustment getSettlementDateOffset()
        Gets the number of days between valuation date and settlement date.

        It is usually one business day for US and UK bills and two days for Euroland government bills.

        the value of the property, not null
      • toBuilder

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

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

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

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