Class FxOptionVolatilitiesDefinition

  • All Implemented Interfaces:
    java.io.Serializable, Bean, ImmutableBean

    public final class FxOptionVolatilitiesDefinition
    extends java.lang.Object
    implements ImmutableBean, java.io.Serializable
    The definition of how to build FX option volatilities.

    This stores an instance of specification FxOptionVolatilitiesSpecification which allows different kinds of volatility to be created.

    See Also:
    Serialized Form
    • Method Detail

      • volatilities

        public FxOptionVolatilities volatilities​(java.time.ZonedDateTime valuationDateTime,
                                                 DoubleArray parameters,
                                                 ReferenceData refData)
        Creates FX option volatilities.

        The number and ordering of parameters must be coherent to those of nodes, #getNodes().

        Parameters:
        valuationDateTime - the valuation date time
        parameters - the parameters
        refData - the reference data
        Returns:
        the volatilities
      • volatilitiesInputs

        public com.google.common.collect.ImmutableList<QuoteId> volatilitiesInputs()
        Obtains the inputs required to create the FX option volatilities.
        Returns:
        the inputs
      • getParameterCount

        public int getParameterCount()
        Gets the number of parameters.
        Returns:
        the number of parameters
      • getSpecification

        public FxOptionVolatilitiesSpecification getSpecification()
        Gets the FX option volatility specification.
        Returns:
        the value of the property, 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