Package com.almworks.jira.structure.api.effect

Interface Effect

@PublicSpi
public interface Effect

A piece of runnable code generated by an effect provider from an effect description.

Method Summary

Modifier and Type	Method	Description
StoredEffect	apply()	Performs the actual changes in the state of the world.

Method Details

apply

@NotNull
StoredEffect apply()
            throws StructureException

Performs the actual changes in the state of the world. Returns an effect desription that undoes those changes.

Throws:

StructureException - if it is impossible to apply the effect despite all prior checks made by the EffectProvider. Usually means that the state of the world has changed unexpectedly since those checks were made.