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

Class StoredEffect

Object

StoredEffect

@PublicApi
public final class StoredEffect
extends Object

A description of an effect that can be stored in the database or passed over the wire. Contains an effect provider module key and implementation-specific parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StoredEffect.Builder	Builder class for effect descriptions.

Constructor Summary

Constructors

Constructor	Description
StoredEffect(String moduleKey, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method	Description
static StoredEffect.Builder	builder(String moduleKey)	Returns a new builder with the given module key.
boolean	equals(Object o)
String	getModuleKey()	The complete module key of the EffectProvider responsible for converting this effect description to an actual Effect.
Map<String,Object>	getParameters()	Provider-specific parameters, e.g.
int	hashCode()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StoredEffect

public StoredEffect(@NotNull
 String moduleKey,
 @NotNull
 Map<String,Object> parameters)

Method Details

getModuleKey

@NotNull
public String getModuleKey()

The complete module key of the EffectProvider responsible for converting this effect description to an actual Effect.

getParameters

@NotNull
public Map<String,Object> getParameters()

Provider-specific parameters, e.g. an issue ID, a field ID, and a value.

builder

@NotNull
public static StoredEffect.Builder builder(@NotNull
 String moduleKey)

Returns a new builder with the given module key.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object