Interface CreditRatesScenarioMarketData


  • public interface CreditRatesScenarioMarketData
    Market data for products based on credit, discount and recovery rate curves, used for calculation across multiple scenarios.

    This interface exposes the market data necessary for pricing credit products, such as CDS and CDS index. It uses a CreditRatesMarketDataLookup to provide a view on ScenarioMarketData.

    Implementations of this interface must be immutable.

    • Method Detail

      • getLookup

        CreditRatesMarketDataLookup getLookup()
        Gets the lookup that provides access to credit, discount and recovery rate curves.
        Returns:
        the credit rates lookup
      • getMarketData

        ScenarioMarketData getMarketData()
        Gets the market data.
        Returns:
        the market data
      • withMarketData

        CreditRatesScenarioMarketData withMarketData​(ScenarioMarketData marketData)
        Returns a copy of this instance with the specified market data.
        Parameters:
        marketData - the market data to use
        Returns:
        a market view based on the specified data
      • getScenarioCount

        int getScenarioCount()
        Gets the number of scenarios.
        Returns:
        the number of scenarios
      • scenario

        CreditRatesMarketData scenario​(int scenarioIndex)
        Returns market data for a single scenario.

        This returns a view of the market data for the specified scenario.

        Parameters:
        scenarioIndex - the scenario index
        Returns:
        the market data for the specified scenario
        Throws:
        IndexOutOfBoundsException - if the scenario index is invalid