Record Class ScenarioBand

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.cost.ScenarioBand

Record Components:

specFingerprint - the spec's fingerprint

currency - the currency of every amount

horizonMonths - the horizon

cases - the low, base and high cases

simulation - the Monte Carlo summary, or null when none was requested

unpriced - items that could not be priced, with the reason

assumptions - the modelling assumptions

public record ScenarioBand(String specFingerprint, String currency, int horizonMonths, List<ScenarioBand.Case> cases, ScenarioBand.Simulation simulation, List<String> unpriced, List<String> assumptions)
extends Record

Cost over the horizon under a range of growth, from GrowthPlanner.scenarios(double, double, GrowthPlanner.MonteCarlo): deterministic low/base/high cases and, when requested, a seeded Monte Carlo with its distributions stated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ScenarioBand.Case	One deterministic case.
static final record	ScenarioBand.Simulation	A seeded Monte Carlo summary: re-running with the same seed and inputs gives the same figures.

Constructor Summary

Constructors

Constructor	Description
ScenarioBand(String specFingerprint, String currency, int horizonMonths, List<ScenarioBand.Case> cases, ScenarioBand.Simulation simulation, List<String> unpriced, List<String> assumptions)	Copies the lists.

Method Summary

Modifier and Type	Method	Description
List<String>	assumptions()	Returns the value of the assumptions record component.
List<ScenarioBand.Case>	cases()	Returns the value of the cases record component.
String	currency()	Returns the value of the currency record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	horizonMonths()	Returns the value of the horizonMonths record component.
ScenarioBand.Simulation	simulation()	Returns the value of the simulation record component.
String	specFingerprint()	Returns the value of the specFingerprint record component.
String	toMarkdown()
final String	toString()	Returns a string representation of this record class.
List<String>	unpriced()	Returns the value of the unpriced record component.

Methods inherited from class Object

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

Constructor Details

ScenarioBand

public ScenarioBand(String specFingerprint,
 String currency,
 int horizonMonths,
 List<ScenarioBand.Case> cases,
 ScenarioBand.Simulation simulation,
 List<String> unpriced,
 List<String> assumptions)

Copies the lists.

Method Details

toMarkdown

public String toMarkdown()

Returns:

a Markdown report of the cases and the simulation

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

specFingerprint

public String specFingerprint()

Returns the value of the specFingerprint record component.

Returns:

the value of the specFingerprint record component

currency

public String currency()

Returns the value of the currency record component.

Returns:

the value of the currency record component

horizonMonths

public int horizonMonths()

Returns the value of the horizonMonths record component.

Returns:

the value of the horizonMonths record component

cases

public List<ScenarioBand.Case> cases()

Returns the value of the cases record component.

Returns:

the value of the cases record component

simulation

public ScenarioBand.Simulation simulation()

Returns the value of the simulation record component.

Returns:

the value of the simulation record component

unpriced

public List<String> unpriced()

Returns the value of the unpriced record component.

Returns:

the value of the unpriced record component

assumptions

public List<String> assumptions()

Returns the value of the assumptions record component.

Returns:

the value of the assumptions record component