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

Class StoredEffect.Builder

Object

Builder

Enclosing class:

StoredEffect

public static final class StoredEffect.Builder
extends Object

Builder class for effect descriptions.

Constructor Summary

Constructors

Constructor	Description
Builder(StoredEffect storedEffect)	Creates a new builder with the module key and parameters taken from the given effect description.
Builder(String moduleKey)	Creates a new builder with the given effect provider module key and no parameters.

Method Summary

Modifier and Type	Method	Description
StoredEffect	build()	Creates and returns a new StoredEffect instance with the module key and parameters from this builder.
StoredEffect.Builder	setModuleKey(String moduleKey)	Updates the effect provider module key.
StoredEffect.Builder	setParameter(String key, Object value)	Updates a provider-specific parameter.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder(@NotNull
 String moduleKey)

Creates a new builder with the given effect provider module key and no parameters.

Parameters:

moduleKey - the module key

Builder

public Builder(@NotNull
 StoredEffect storedEffect)

Creates a new builder with the module key and parameters taken from the given effect description.

Parameters:

storedEffect - the source effect description

Method Details

setModuleKey

@NotNull
public StoredEffect.Builder setModuleKey(@NotNull
 String moduleKey)

Updates the effect provider module key.

Parameters:

moduleKey - the module key

Returns:

this builder

setParameter

@NotNull
public StoredEffect.Builder setParameter(@NotNull
 String key,
 @Nullable
 Object value)

Updates a provider-specific parameter.

Parameters:

key - parameter key

value - parameter value; passing null deletes the parameter

Returns:

this builder

build

@NotNull
public StoredEffect build()

Creates and returns a new StoredEffect instance with the module key and parameters from this builder.

Returns:

a new effect description