com.atlassian.bamboo.task

Class TaskDefinitionImpl

java.lang.Object

com.atlassian.bamboo.task.TaskDefinitionImpl

All Implemented Interfaces:

EntityWithOid, ImmutableEntityWithOid, PluginKeyProvider, TaskDefinition, TaskIdentifier, Serializable

Direct Known Subclasses:

DecoratedTaskDefinitionImpl, RuntimeTaskDefinitionImpl

@Internal
public class TaskDefinitionImpl
extends Object
implements TaskDefinition

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.atlassian.bamboo.task.TaskDefinition

DISABLED, ENABLED

Constructor Summary

Constructors

Constructor and Description
TaskDefinitionImpl(long id, String pluginKey, String userDescription, boolean isEnabled, List<TaskConditionConfig> conditions, Map<String,String> configuration, boolean finalising)
TaskDefinitionImpl(long id, String pluginKey, String userDescription, boolean isEnabled, List<TaskConditionConfig> conditions, Map<String,String> configuration, boolean finalising, TaskRootDirectorySelector taskRootDirectorySelector)
TaskDefinitionImpl(long id, String pluginKey, String userDescription, boolean isEnabled, Map<String,String> configuration)
TaskDefinitionImpl(long id, String pluginKey, String userDescription, boolean isEnabled, Map<String,String> configuration, boolean finalising)
TaskDefinitionImpl(long id, String pluginKey, String userDescription, boolean isEnabled, Map<String,String> configuration, boolean finalising, TaskRootDirectorySelector taskRootDirectorySelector)
TaskDefinitionImpl(long id, String pluginKey, String userDescription, Map<String,String> taskConfigMap)
TaskDefinitionImpl(long id, String pluginKey, String userDescription, Map<String,String> configuration, boolean finalising)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object obj)
boolean	equals(Object o)
List<TaskConditionConfig>	getConditions()
Map<String,String>	getConfiguration() Represents the raw configuration data for this configuration.
long	getId()
BambooEntityOid	getOid() OID assigned to this object.
String	getPluginKey()
TaskRootDirectorySelector	getRootDirectorySelector()
String	getUserDescription()
int	hashCode()
boolean	isEnabled()
boolean	isFinalising()
void	setConditions(List<TaskConditionConfig> conditions)
void	setConfiguration(Map<String,String> configuration)
void	setEnabled(boolean isEnabled) Tells bamboo whether this task should run as a part of this build or not.
void	setFinalising(boolean finalising)
void	setOid(BambooEntityOid oid) Assign a new BambooEntityOid to this object.
void	setRootDirectorySelector(TaskRootDirectorySelector rootDirectorySelector)
void	setUserDescription(String userDescription)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.task.TaskDefinition

getEntityType

Constructor Detail

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          @NotNull
                          Map<String,String> taskConfigMap)

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          boolean isEnabled,
                          @NotNull
                          Map<String,String> configuration)

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          boolean isEnabled,
                          @NotNull
                          Map<String,String> configuration,
                          boolean finalising)

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          boolean isEnabled,
                          @NotNull
                          List<TaskConditionConfig> conditions,
                          @NotNull
                          Map<String,String> configuration,
                          boolean finalising)

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          @NotNull
                          Map<String,String> configuration,
                          boolean finalising)

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          boolean isEnabled,
                          @NotNull
                          Map<String,String> configuration,
                          boolean finalising,
                          @NotNull
                          TaskRootDirectorySelector taskRootDirectorySelector)

TaskDefinitionImpl

public TaskDefinitionImpl(long id,
                          @NotNull
                          String pluginKey,
                          @Nullable
                          String userDescription,
                          boolean isEnabled,
                          @NotNull
                          List<TaskConditionConfig> conditions,
                          @NotNull
                          Map<String,String> configuration,
                          boolean finalising,
                          @NotNull
                          TaskRootDirectorySelector taskRootDirectorySelector)

Method Detail

getId

public long getId()

Specified by:

getId in interface TaskIdentifier

Returns:

the id of this configuration. Unique within the given context (e.g. Job

getPluginKey

@NotNull
public String getPluginKey()

Specified by:

getPluginKey in interface PluginKeyProvider

Specified by:

getPluginKey in interface TaskIdentifier

Returns:

Complete key of the task type plugin module

getUserDescription

@Nullable
public String getUserDescription()

Specified by:

getUserDescription in interface TaskIdentifier

Returns:

the description of the task as defined by the user

setUserDescription

public void setUserDescription(@Nullable
                               String userDescription)

Specified by:

setUserDescription in interface TaskDefinition

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface TaskIdentifier

Returns:

whether the task is enabled or disabled

setEnabled

public void setEnabled(boolean isEnabled)

Description copied from interface: TaskDefinition

Tells bamboo whether this task should run as a part of this build or not.

Specified by:

setEnabled in interface TaskDefinition

getConditions

@NotNull
public List<TaskConditionConfig> getConditions()

Specified by:

getConditions in interface TaskDefinition

Returns:

task conditions. UI supports only one condition per task.

setConditions

public void setConditions(@NotNull
                          List<TaskConditionConfig> conditions)

Specified by:

setConditions in interface TaskDefinition

getConfiguration

@NotNull
public Map<String,String> getConfiguration()

Description copied from interface: TaskDefinition

Represents the raw configuration data for this configuration. No variables are substituted.

Specified by:

getConfiguration in interface TaskDefinition

Returns:

the plugin defined configuration for this task

setConfiguration

public void setConfiguration(@NotNull
                             Map<String,String> configuration)

Specified by:

setConfiguration in interface TaskDefinition

isFinalising

public boolean isFinalising()

Specified by:

isFinalising in interface TaskIdentifier

Returns:

true if the task should be run in finalisation phase

setFinalising

public void setFinalising(boolean finalising)

Specified by:

setFinalising in interface TaskDefinition

getRootDirectorySelector

@NotNull
public TaskRootDirectorySelector getRootDirectorySelector()

Specified by:

getRootDirectorySelector in interface TaskDefinition

Returns:

data defining tasks' root directory

setRootDirectorySelector

public void setRootDirectorySelector(@NotNull
                                     TaskRootDirectorySelector rootDirectorySelector)

Specified by:

setRootDirectorySelector in interface TaskDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(Object obj)

toString

public String toString()

Overrides:

toString in class Object

setOid

public void setOid(BambooEntityOid oid)

Description copied from interface: EntityWithOid

Assign a new BambooEntityOid to this object. The BambooEntityOid.getEntityType() should be the same as this object's ImmutableEntityWithOid.getEntityType().

Specified by:

setOid in interface EntityWithOid

getOid

public BambooEntityOid getOid()

Description copied from interface: ImmutableEntityWithOid

OID assigned to this object. The BambooEntityOid.getEntityType() should be the same as this object's ImmutableEntityWithOid.getEntityType().

Specified by:

getOid in interface ImmutableEntityWithOid