Package ca.cgjennings.apps.arkham.project

Class Run

  • All Implemented Interfaces:
    IconProvider
    public class Run
extends TaskAction
    Task action that runs or debugs a selected script. Action to run or debug a script.
    Since:
    2.1
    Author:
    Chris Jennings

    • Constructor Summary

      Constructors 
      Constructor Description
      Run​(boolean debugAction)
      Creates a new run or debug action, depending on the specified parameter.

    • Constructor Detail

      • Run

        public Run​(boolean debugAction)
        Creates a new run or debug action, depending on the specified parameter.
        Parameters:
        debugAction - if true, creates a debug action rather than a plain run action

    • 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

      • getActionName

        public java.lang.String getActionName()
        Description copied from class: TaskAction
        Returns a unique internal name for this action. Actions can be looked up by this name. The default implementation returns the class name, converted to lowercase.
        Overrides:
        getActionName in class TaskAction
        Returns:
        the internal name of this action

      • 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

      • runFile

        public boolean runFile​(java.io.File f,
                       Project project,
                       Task task,
                       Member member)
        Run a script file as if using this action. The variables project, task, and member are passed to the script but may be null if the script does not rely on them. If the script is currently being edited by the application, any unsaved changes will be saved before running.
        Parameters:
        f - the script file to run
        project - the project instance to pass to the script
        task - the task instance to pass to the script
        member - the member instance to pass to the script
        Returns:
        true if the script is successfully loaded and run
        Throws:
        java.lang.NullPointerException - if f is null