Package ca.cgjennings.apps.arkham.project

Class MakeBundle

java.lang.Object

ca.cgjennings.apps.arkham.project.TaskAction

ca.cgjennings.apps.arkham.project.MakeBundle

All Implemented Interfaces:

IconProvider

public class MakeBundle
extends TaskAction

Task action that creates a plug-in bundle from the contents of a plug-in task folder. The bundle is written to the project folder using the name stored in the task's KEY_BUNDLE_FILE (bundle-file). If this key is not defined, then bundle.seplugin is used as a base.

Since:

2.1

Author:

Chris Jennings

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	KEY_AUTOTOUCH	User setting that controls whether root file IDs are touched automatically during the make.
static java.lang.String	KEY_BUNDLE_FILE	Task setting that stores the name of the file to use for the bundle.

Constructor Summary

Constructors

Constructor	Description
MakeBundle()

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(Project project, Task task, Member member)	Returns true if this action can be performed on the specified member of a project, project or a task.
java.lang.String	getDescription()	Returns a longer description of the action, suitable for use as a tool tip.
java.lang.String	getLabel()	Returns the human-readable name of this action.
boolean	perform(Project project, Task task, Member member)	Perform this action on a member of a project, a project or a task.

Methods inherited from class ca.cgjennings.apps.arkham.project.TaskAction

appliesToSelection, applyToChildren, getActionName, getIcon, performOnSelection, resolveTarget, toString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_BUNDLE_FILE

public static final java.lang.String KEY_BUNDLE_FILE

Task setting that stores the name of the file to use for the bundle.

See Also:

Constant Field Values

KEY_AUTOTOUCH

public static final java.lang.String KEY_AUTOTOUCH

User setting that controls whether root file IDs are touched automatically during the make.

See Also:

Constant Field Values

Constructor Detail

MakeBundle

public MakeBundle()

Method Detail

getLabel

public java.lang.String getLabel()

Description copied from class: TaskAction

Returns the human-readable name of this action.

Specified by:

getLabel in class TaskAction

Returns:

the name used to create menu items for this action, localized if possible

getDescription

public java.lang.String getDescription()

Description copied from class: TaskAction

Returns a longer description of the action, suitable for use as a tool tip.

Overrides:

getDescription in class TaskAction

Returns:

a long description of the action, or null

appliesTo

public boolean appliesTo(Project project,
                         Task task,
                         Member member)

Description copied from class: TaskAction

Returns true if this action can be performed on the specified member of a project, project or a task. If the project itself is the target, task and member will be null. If a task is the target, then member will be null. If an error occurs while executing the task, then it is the action's responsibility to inform the user. This method can return false to indicate that if the action is being applied to multiple members, it should stop immediately rather than continue to the next member.

Specified by:

appliesTo in class TaskAction

Parameters:

project - the project that is being acted upon

task - the task within the project that is being acted upon; null if acting on a project

member - the specific member within the task to act upon; null if this is a project or task

perform

public boolean perform(Project project,
                       Task task,
                       Member member)

Description copied from class: TaskAction

Perform this action on a member of a project, a project or a task. If the project itself is the target, task and member will be null. If a task is the target, then member will be null. If an error occurs while executing the task, then it is the action's responsibility to inform the user. This method can return false to indicate that if the action is being applied to multiple members, it should stop immediately rather than continue to the next member.

Specified by:

perform in class TaskAction

Parameters:

project - the project that is being acted upon

task - the task within the project that is being acted upon; null if acting on a project

member - the specific member within the task to act upon; null if this is a project or task