com.opengamma.strata.calc.runner

Class FunctionRequirements

java.lang.Object

com.opengamma.strata.calc.runner.FunctionRequirements

All Implemented Interfaces:

org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class FunctionRequirements
extends Object
implements org.joda.beans.ImmutableBean

Specifies the market data required for a function to perform a calculation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FunctionRequirements.Builder The bean-builder for FunctionRequirements.
static class	FunctionRequirements.Meta The meta-bean for FunctionRequirements.

Method Summary

Modifier and Type	Method and Description
static FunctionRequirements.Builder	builder() Returns a builder used to create an instance of the bean.
FunctionRequirements	combinedWith(FunctionRequirements other) Combines these requirements with another set.
static FunctionRequirements	empty() Returns an empty set of requirements.
boolean	equals(Object obj)
ObservableSource	getObservableSource() Gets the source of market data for FX, quotes and other observable market data.
ImmutableSet<Currency>	getOutputCurrencies() Gets the currencies used in the calculation results.
ImmutableSet<ObservableId>	getTimeSeriesRequirements() Gets the market data identifiers of the time-series of required for the calculation.
ImmutableSet<? extends MarketDataId<?>>	getValueRequirements() Gets the market data identifiers of the values required for the calculation.
int	hashCode()
static FunctionRequirements.Meta	meta() The meta-bean for FunctionRequirements.
FunctionRequirements.Meta	metaBean()
FunctionRequirements.Builder	toBuilder() Returns a builder that allows this bean to be mutated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

empty

public static FunctionRequirements empty()

Returns an empty set of requirements.

Returns:

an empty set of requirements

combinedWith

public FunctionRequirements combinedWith(FunctionRequirements other)

Combines these requirements with another set.

The result contains the union of the two sets of requirements.

Parameters:

other - the other requirements

Returns:

the combined requirements

meta

public static FunctionRequirements.Meta meta()

The meta-bean for FunctionRequirements.

Returns:

the meta-bean, not null

builder

public static FunctionRequirements.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public FunctionRequirements.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getValueRequirements

public ImmutableSet<? extends MarketDataId<?>> getValueRequirements()

Gets the market data identifiers of the values required for the calculation.

Returns:

the value of the property, not null

getTimeSeriesRequirements

public ImmutableSet<ObservableId> getTimeSeriesRequirements()

Gets the market data identifiers of the time-series of required for the calculation.

Returns:

the value of the property, not null

getOutputCurrencies

public ImmutableSet<Currency> getOutputCurrencies()

Gets the currencies used in the calculation results.

This cause FX rates to be requested that allow conversion between the currencies specified and the reporting currency. It will be possible to obtain any FX rate pair for these currencies.

Returns:

the value of the property, not null

getObservableSource

public ObservableSource getObservableSource()

Gets the source of market data for FX, quotes and other observable market data.

This is used to control the source of observable market data. By default, this will be ObservableSource.NONE.

Returns:

the value of the property, not null

toBuilder

public FunctionRequirements.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object