Class ReplaceOperation

java.lang.Object

org.kigalisim.lang.operation.ReplaceOperation

All Implemented Interfaces:

Operation

public class ReplaceOperation
extends Object
implements Operation

Operation that replaces a substance with another substance.

This operation calculates a replacement amount and applies it to the engine. It can optionally be limited to a specific time period using a ParsedDuring object.

Constructor Summary

Constructors

Constructor	Description
ReplaceOperation(Operation amountOperation, String stream, String destinationSubstance)	Create a new ReplaceOperation that applies to all years.
ReplaceOperation(Operation amountOperation, String stream, String destinationSubstance, ParsedDuring during)	Create a new ReplaceOperation that applies to a specific time period.

Method Summary

Modifier and Type	Method	Description
void	execute(PushDownMachine machine)	Execute the calculation and leave the result at the top of the stack.
OperationStaticSemantics	getStaticSemantics()	Get a record describing this operation's semantics.

Methods inherited from class Object

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

Constructor Details

ReplaceOperation

public ReplaceOperation(Operation amountOperation,
 String stream,
 String destinationSubstance)

Create a new ReplaceOperation that applies to all years.

Parameters:

amountOperation - The operation that calculates the replacement amount.

stream - The stream to replace.

destinationSubstance - The substance to replace with.

ReplaceOperation

public ReplaceOperation(Operation amountOperation,
 String stream,
 String destinationSubstance,
 ParsedDuring during)

Create a new ReplaceOperation that applies to a specific time period.

Parameters:

amountOperation - The operation that calculates the replacement amount.

stream - The stream to replace.

destinationSubstance - The substance to replace with.

during - The time period during which this operation applies.

Method Details

execute

public void execute(PushDownMachine machine)

Execute the calculation and leave the result at the top of the stack.

Specified by:

execute in interface Operation

Parameters:

machine - The machine in which to execute the calculation if needed.

getStaticSemantics

public OperationStaticSemantics getStaticSemantics()

Get a record describing this operation's semantics.

Get a record describing this operation's semantics that are inferrable from its static expression in code. In other words, properties and effects which do not require inspection at time of executing the operation.

Specified by:

getStaticSemantics in interface Operation

Returns:

Inference of common static properties found for this operation.