Package org.kigalisim.engine.support

Class ChangeExecutorConfig

java.lang.Object

org.kigalisim.engine.support.ChangeExecutorConfig

public final class ChangeExecutorConfig
extends Object

Configuration for change executor operations.

This immutable class encapsulates all parameters needed for executing change operations on engine streams.

Constructor Summary

Constructors

Constructor	Description
ChangeExecutorConfig(String stream, EngineNumber amount, Optional<YearMatcher> yearMatcher, UseKey useKeyEffective)	Creates a new ChangeExecutorConfig.
ChangeExecutorConfig(String stream, EngineNumber amount, UseKey useKeyEffective)	Creates a new ChangeExecutorConfig without a year matcher.
ChangeExecutorConfig(String stream, EngineNumber amount, YearMatcher yearMatcher, UseKey useKeyEffective)	Creates a new ChangeExecutorConfig with a YearMatcher.

Method Summary

Modifier and Type	Method	Description
EngineNumber	getAmount()	Gets the change amount.
String	getStream()	Gets the stream identifier.
UseKey	getUseKeyEffective()	Gets the effective use key.
Optional<YearMatcher>	getYearMatcher()	Gets the year matcher.

Methods inherited from class java.lang.Object

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

Constructor Details

ChangeExecutorConfig

public ChangeExecutorConfig(String stream,
 EngineNumber amount,
 Optional<YearMatcher> yearMatcher,
 UseKey useKeyEffective)

Creates a new ChangeExecutorConfig.

Parameters:

stream - The stream identifier to modify

amount - The change amount (percentage, units, or kg)

yearMatcher - Optional matcher to determine if the change applies to current year

useKeyEffective - The effective UseKey for the operation

ChangeExecutorConfig

public ChangeExecutorConfig(String stream,
 EngineNumber amount,
 YearMatcher yearMatcher,
 UseKey useKeyEffective)

Creates a new ChangeExecutorConfig with a YearMatcher.

Parameters:

stream - The stream identifier to modify

amount - The change amount (percentage, units, or kg)

yearMatcher - Matcher to determine if the change applies to current year

useKeyEffective - The effective UseKey for the operation

ChangeExecutorConfig

public ChangeExecutorConfig(String stream,
 EngineNumber amount,
 UseKey useKeyEffective)

Creates a new ChangeExecutorConfig without a year matcher.

This configuration will apply to all years since no year matching is specified.

Parameters:

stream - The stream identifier to modify

amount - The change amount (percentage, units, or kg)

useKeyEffective - The effective UseKey for the operation

Method Details

getStream

public String getStream()

Gets the stream identifier.

Returns:

the stream identifier

getAmount

public EngineNumber getAmount()

Gets the change amount.

Returns:

the change amount

getYearMatcher

public Optional<YearMatcher> getYearMatcher()

Gets the year matcher.

Returns:

the year matcher wrapped in Optional, or Optional.empty() if not specified

getUseKeyEffective

public UseKey getUseKeyEffective()

Gets the effective use key.

Returns:

the effective use key