com.almworks.jira.structure.api.forest

Class ForestSpec.Transformation

java.lang.Object

com.almworks.jira.structure.api.forest.ForestSpec.Transformation

Enclosing class:

ForestSpec

public static final class ForestSpec.Transformation
extends Object

Represents a transformation, which is a call to a generator with specified parameters.

See Also:

CoreStructureGenerators, CoreGeneratorParameters

Constructor Summary

Constructors

Constructor and Description
Transformation(String module, Map<String,Object> params) Creates a transformation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getModule() Returns the complete module key of the generator.
Map<String,Object>	getParams() Returns optional parameters for the generator.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Transformation

public Transformation(@NotNull
                      String module,
                      @Nullable
                      Map<String,Object> params)

Creates a transformation.

Note that the generator, referred by module, must not be an Inserter. Although Structure does not verify the type of the generator passed here, the results of passing an Inserter are not defined.

Parameters:

module - complete module key of the generator module

params - optional map with generator parameters

See Also:

CoreStructureGenerators, CoreGeneratorParameters

Method Detail

getModule

@NotNull
public String getModule()

Returns the complete module key of the generator.

getParams

@Nullable
public Map<String,Object> getParams()

Returns optional parameters for the generator.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object