Package com.almworks.jira.structure.api.effector

Interface EffectorContext

@PublicApi
public interface EffectorContext

A context object for Effector.getEffectorFunction(Map, EffectorContext), which allows the effector to require attribute values and inspect the forest spec being processed.

Method Summary

Modifier and Type	Method	Description
ForestSpec	getForestSpec()	Returns the forest spec processed by the current effector invocation.
void	requireAttribute(AttributeSpec<?> attribute)	Allows the effector to require an attribute that it needs in order to produce effects.

Method Details

requireAttribute

void requireAttribute(@NotNull
 AttributeSpec<?> attribute)

Allows the effector to require an attribute that it needs in order to produce effects.

Required attribute values for all processed rows, if available, will be passed to EffectorFunction.produceEffects(ItemForest, RowValues, EffectCollector, ProgressSink).

Parameters:

attribute - the attribute spec

getForestSpec

@NotNull
ForestSpec getForestSpec()

Returns the forest spec processed by the current effector invocation.