Package org.kigalisim.engine.state

Class FrozenPriorEquipmentBases

java.lang.Object

org.kigalisim.engine.state.FrozenPriorEquipmentBases

All Implemented Interfaces:

PriorEquipmentBases

public class FrozenPriorEquipmentBases
extends Object
implements PriorEquipmentBases

Immutable snapshot of PriorEquipmentBases state.

Holds only final fields populated at construction and throws UnsupportedOperationException from every mutator, so a snapshot captured for a prior-year lookup can never be silently corrupted.

Constructor Summary

Constructors

Constructor

Description

FrozenPriorEquipmentBases(Optional<EngineNumber> retirementBasePopulation, Optional<EngineNumber> appliedRetirementAmount, boolean hasReplacementThisStep, boolean retireCalculatedThisStep, Optional<EngineNumber> rechargeBasePopulation, Optional<EngineNumber> appliedRechargeAmount, Optional<EngineNumber> prechargeBasePopulation, Optional<EngineNumber> appliedPrechargeAmount, boolean recyclingCalculatedThisStep)

Create a new immutable snapshot with the specified field values.

Method Summary

Modifier and Type	Method	Description
PriorEquipmentBases	freeze()	Get an immutable snapshot of this instance.
Optional<EngineNumber>	getAppliedPrechargeAmount()	Get the applied precharge amount.
Optional<EngineNumber>	getAppliedRechargeAmount()	Get the applied recharge amount.
Optional<EngineNumber>	getAppliedRetirementAmount()	Get the applied retirement amount.
boolean	getHasReplacementThisStep()	Get whether replacement was used in this step's retire commands.
Optional<EngineNumber>	getPrechargeBasePopulation()	Get the precharge base population.
Optional<EngineNumber>	getRechargeBasePopulation()	Get the recharge base population.
boolean	getRecyclingCalculatedThisStep()	Get whether recycling has been calculated this step.
boolean	getRetireCalculatedThisStep()	Get whether retire has been calculated this step.
Optional<EngineNumber>	getRetirementBasePopulation()	Get the retirement base population.
void	resetStateAtTimestep()	Reset all tracking state at the beginning of a timestep.
void	setAppliedPrechargeAmount(EngineNumber value)	Set the applied precharge amount.
void	setAppliedRechargeAmount(EngineNumber value)	Set the applied recharge amount.
void	setAppliedRetirementAmount(EngineNumber value)	Set the applied retirement amount.
void	setHasReplacementThisStep(boolean value)	Set whether replacement is used in this step's retire commands.
void	setPrechargeBasePopulation(EngineNumber value)	Set the precharge base population.
void	setRechargeBasePopulation(EngineNumber value)	Set the recharge base population.
void	setRecyclingCalculatedThisStep(boolean calculated)	Set whether recycling has been calculated this step.
void	setRetireCalculatedThisStep(boolean calculated)	Set whether retire has been calculated this step.
void	setRetirementBasePopulation(EngineNumber value)	Set the retirement base population.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FrozenPriorEquipmentBases

public FrozenPriorEquipmentBases(Optional<EngineNumber> retirementBasePopulation,
 Optional<EngineNumber> appliedRetirementAmount,
 boolean hasReplacementThisStep,
 boolean retireCalculatedThisStep,
 Optional<EngineNumber> rechargeBasePopulation,
 Optional<EngineNumber> appliedRechargeAmount,
 Optional<EngineNumber> prechargeBasePopulation,
 Optional<EngineNumber> appliedPrechargeAmount,
 boolean recyclingCalculatedThisStep)

Create a new immutable snapshot with the specified field values.

Parameters:

retirementBasePopulation - The retirement base population, or empty if not captured

appliedRetirementAmount - The total amount already retired this step

hasReplacementThisStep - Whether replacement was used in this step's retire commands

retireCalculatedThisStep - Whether retire has been calculated this step

rechargeBasePopulation - The recharge base population, or empty if not captured

appliedRechargeAmount - The total amount already recharged this step in kg

prechargeBasePopulation - The precharge base population, or empty if not captured

appliedPrechargeAmount - The total amount already precharged this step in kg

recyclingCalculatedThisStep - Whether recycling has been calculated this step

Method Details

getRetirementBasePopulation

public Optional<EngineNumber> getRetirementBasePopulation()

Get the retirement base population.

Specified by:

getRetirementBasePopulation in interface PriorEquipmentBases

Returns:

The base population, or empty if not yet captured this step

setRetirementBasePopulation

public void setRetirementBasePopulation(EngineNumber value)

Set the retirement base population.

Specified by:

setRetirementBasePopulation in interface PriorEquipmentBases

Parameters:

value - The base population value

Throws:

UnsupportedOperationException - always, since this instance is frozen

getAppliedRetirementAmount

public Optional<EngineNumber> getAppliedRetirementAmount()

Get the applied retirement amount.

Specified by:

getAppliedRetirementAmount in interface PriorEquipmentBases

Returns:

The total amount already retired this step

setAppliedRetirementAmount

public void setAppliedRetirementAmount(EngineNumber value)

Set the applied retirement amount.

Specified by:

setAppliedRetirementAmount in interface PriorEquipmentBases

Parameters:

value - The total amount retired this step

Throws:

UnsupportedOperationException - always, since this instance is frozen

getHasReplacementThisStep

public boolean getHasReplacementThisStep()

Get whether replacement was used in this step's retire commands.

Specified by:

getHasReplacementThisStep in interface PriorEquipmentBases

Returns:

true if with replacement, false if without replacement

setHasReplacementThisStep

public void setHasReplacementThisStep(boolean value)

Set whether replacement is used in this step's retire commands.

Specified by:

setHasReplacementThisStep in interface PriorEquipmentBases

Parameters:

value - true for with replacement, false for without replacement

Throws:

UnsupportedOperationException - always, since this instance is frozen

getRetireCalculatedThisStep

public boolean getRetireCalculatedThisStep()

Get whether retire has been calculated this step.

Specified by:

getRetireCalculatedThisStep in interface PriorEquipmentBases

Returns:

true if retire was calculated, false otherwise

setRetireCalculatedThisStep

public void setRetireCalculatedThisStep(boolean calculated)

Set whether retire has been calculated this step.

Specified by:

setRetireCalculatedThisStep in interface PriorEquipmentBases

Parameters:

calculated - true if retire was calculated, false otherwise

Throws:

UnsupportedOperationException - always, since this instance is frozen

getRechargeBasePopulation

public Optional<EngineNumber> getRechargeBasePopulation()

Get the recharge base population.

Specified by:

getRechargeBasePopulation in interface PriorEquipmentBases

Returns:

The base population, or empty if not yet captured this step

setRechargeBasePopulation

public void setRechargeBasePopulation(EngineNumber value)

Set the recharge base population.

Specified by:

setRechargeBasePopulation in interface PriorEquipmentBases

Parameters:

value - The base population value

Throws:

UnsupportedOperationException - always, since this instance is frozen

getAppliedRechargeAmount

public Optional<EngineNumber> getAppliedRechargeAmount()

Get the applied recharge amount.

Specified by:

getAppliedRechargeAmount in interface PriorEquipmentBases

Returns:

The total amount already recharged this step in kg

setAppliedRechargeAmount

public void setAppliedRechargeAmount(EngineNumber value)

Set the applied recharge amount.

Specified by:

setAppliedRechargeAmount in interface PriorEquipmentBases

Parameters:

value - The total amount recharged this step in kg

Throws:

UnsupportedOperationException - always, since this instance is frozen

getPrechargeBasePopulation

public Optional<EngineNumber> getPrechargeBasePopulation()

Get the precharge base population.

Specified by:

getPrechargeBasePopulation in interface PriorEquipmentBases

Returns:

The base population, or empty if not yet captured this step

setPrechargeBasePopulation

public void setPrechargeBasePopulation(EngineNumber value)

Set the precharge base population.

Specified by:

setPrechargeBasePopulation in interface PriorEquipmentBases

Parameters:

value - The base population value

Throws:

UnsupportedOperationException - always, since this instance is frozen

getAppliedPrechargeAmount

public Optional<EngineNumber> getAppliedPrechargeAmount()

Get the applied precharge amount.

Specified by:

getAppliedPrechargeAmount in interface PriorEquipmentBases

Returns:

The total amount already precharged this step in kg

setAppliedPrechargeAmount

public void setAppliedPrechargeAmount(EngineNumber value)

Set the applied precharge amount.

Specified by:

setAppliedPrechargeAmount in interface PriorEquipmentBases

Parameters:

value - The total amount precharged this step in kg

Throws:

UnsupportedOperationException - always, since this instance is frozen

getRecyclingCalculatedThisStep

public boolean getRecyclingCalculatedThisStep()

Get whether recycling has been calculated this step.

Specified by:

getRecyclingCalculatedThisStep in interface PriorEquipmentBases

Returns:

true if recycling was calculated, false otherwise

setRecyclingCalculatedThisStep

public void setRecyclingCalculatedThisStep(boolean calculated)

Set whether recycling has been calculated this step.

Specified by:

setRecyclingCalculatedThisStep in interface PriorEquipmentBases

Parameters:

calculated - true if recycling was calculated, false otherwise

Throws:

UnsupportedOperationException - always, since this instance is frozen

resetStateAtTimestep

public void resetStateAtTimestep()

Reset all tracking state at the beginning of a timestep.

Specified by:

resetStateAtTimestep in interface PriorEquipmentBases

Throws:

UnsupportedOperationException - always, since this instance is frozen

freeze

public PriorEquipmentBases freeze()

Get an immutable snapshot of this instance.

The snapshot shares immutable EngineNumber-typed values by reference but does not share mutable containers, so later mutation of this instance does not affect the snapshot.

Specified by:

freeze in interface PriorEquipmentBases

Returns:

this same instance, since it is already frozen