io.github.cdklabs.projen

Class Task

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Task

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.442Z")
 @Stability(value=Experimental)
public class Task
extends software.amazon.jsii.JsiiObject

(experimental) A task that can be performed on the project.

Modeled as a series of shell commands and subtasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Builder (experimental) A fluent builder for Task.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Task(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Task(software.amazon.jsii.JsiiObjectRef objRef)
	Task(String name)
	Task(String name, TaskOptions props)

Method Summary

Modifier and Type	Method and Description
void	builtin(String name) (experimental) Execute a builtin task.
void	env(String name, String value) (experimental) Adds an environment variable to this task.
void	exec(String command) (experimental) Executes a shell command.
void	exec(String command, TaskStepOptions options) (experimental) Executes a shell command.
String	getCondition() (experimental) A command to execute which determines if the task should be skipped.
String	getDescription() (experimental) Returns the description of this task.
String	getName() (experimental) Task name.
List<TaskStep>	getSteps() (experimental) Returns an immutable copy of all the step specifications of the task.
void	lock() (experimental) Forbid additional changes to this task.
void	prepend(String shell) Deprecated. use `prependExec()`
void	prepend(String shell, TaskStepOptions options) Deprecated. use `prependExec()`
void	prependExec(String shell) (experimental) Adds a command at the beginning of the task.
void	prependExec(String shell, TaskStepOptions options) (experimental) Adds a command at the beginning of the task.
void	prependSay(String message) (experimental) Says something at the beginning of the task.
void	prependSay(String message, TaskStepOptions options) (experimental) Says something at the beginning of the task.
void	prependSpawn(Task subtask) (experimental) Adds a spawn instruction at the beginning of the task.
void	prependSpawn(Task subtask, TaskStepOptions options) (experimental) Adds a spawn instruction at the beginning of the task.
void	reset() (experimental) Reset the task so it no longer has any commands.
void	reset(String command) (experimental) Reset the task so it no longer has any commands.
void	reset(String command, TaskStepOptions options) (experimental) Reset the task so it no longer has any commands.
void	say(String message) (experimental) Say something.
void	say(String message, TaskStepOptions options) (experimental) Say something.
void	setDescription(String value) (experimental) Returns the description of this task.
void	spawn(Task subtask) (experimental) Spawns a sub-task.
void	spawn(Task subtask, TaskStepOptions options) (experimental) Spawns a sub-task.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Task

protected Task(software.amazon.jsii.JsiiObjectRef objRef)

Task

protected Task(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Task

@Stability(value=Experimental)
public Task(@NotNull
                                           String name,
                                           @Nullable
                                           TaskOptions props)

Parameters:

name - This parameter is required.

props -

Task

@Stability(value=Experimental)
public Task(@NotNull
                                           String name)

Parameters:

name - This parameter is required.

Method Detail

builtin

@Stability(value=Experimental)
public void builtin(@NotNull
                                                   String name)

(experimental) Execute a builtin task.

Builtin tasks are programs bundled as part of projen itself and used as helpers for various components.

In the future we should support built-in tasks from external modules.

Parameters:

name - The name of the builtin task to execute (e.g. `release/resolve-version`). This parameter is required.

env

@Stability(value=Experimental)
public void env(@NotNull
                                               String name,
                                               @NotNull
                                               String value)

(experimental) Adds an environment variable to this task.

Parameters:

name - The name of the variable. This parameter is required.

value - The value. This parameter is required.

exec

@Stability(value=Experimental)
public void exec(@NotNull
                                                String command,
                                                @Nullable
                                                TaskStepOptions options)

(experimental) Executes a shell command.

Parameters:

command - Shell command. This parameter is required.

options - Options.

exec

@Stability(value=Experimental)
public void exec(@NotNull
                                                String command)

(experimental) Executes a shell command.

Parameters:

command - Shell command. This parameter is required.

lock

@Stability(value=Experimental)
public void lock()

(experimental) Forbid additional changes to this task.

prepend

@Stability(value=Deprecated)
 @Deprecated
public void prepend(@NotNull
                                                              String shell,
                                                              @Nullable
                                                              TaskStepOptions options)

Deprecated. use `prependExec()`

(deprecated) Adds a command at the beginning of the task.

Parameters:

shell - The command to add. This parameter is required.

options -

prepend

@Stability(value=Deprecated)
 @Deprecated
public void prepend(@NotNull
                                                              String shell)

Deprecated. use `prependExec()`

(deprecated) Adds a command at the beginning of the task.

Parameters:

shell - The command to add. This parameter is required.

prependExec

@Stability(value=Experimental)
public void prependExec(@NotNull
                                                       String shell,
                                                       @Nullable
                                                       TaskStepOptions options)

(experimental) Adds a command at the beginning of the task.

Parameters:

shell - The command to add. This parameter is required.

options -

prependExec

@Stability(value=Experimental)
public void prependExec(@NotNull
                                                       String shell)

(experimental) Adds a command at the beginning of the task.

Parameters:

shell - The command to add. This parameter is required.

prependSay

@Stability(value=Experimental)
public void prependSay(@NotNull
                                                      String message,
                                                      @Nullable
                                                      TaskStepOptions options)

(experimental) Says something at the beginning of the task.

Parameters:

message - Your message. This parameter is required.

options -

prependSay

@Stability(value=Experimental)
public void prependSay(@NotNull
                                                      String message)

(experimental) Says something at the beginning of the task.

Parameters:

message - Your message. This parameter is required.

prependSpawn

@Stability(value=Experimental)
public void prependSpawn(@NotNull
                                                        Task subtask,
                                                        @Nullable
                                                        TaskStepOptions options)

(experimental) Adds a spawn instruction at the beginning of the task.

Parameters:

subtask - The subtask to execute. This parameter is required.

options -

prependSpawn

@Stability(value=Experimental)
public void prependSpawn(@NotNull
                                                        Task subtask)

(experimental) Adds a spawn instruction at the beginning of the task.

Parameters:

subtask - The subtask to execute. This parameter is required.

reset

@Stability(value=Experimental)
public void reset(@Nullable
                                                 String command,
                                                 @Nullable
                                                 TaskStepOptions options)

(experimental) Reset the task so it no longer has any commands.

Parameters:

command - the first command to add to the task after it was cleared.

options -

reset

@Stability(value=Experimental)
public void reset(@Nullable
                                                 String command)

(experimental) Reset the task so it no longer has any commands.

Parameters:

command - the first command to add to the task after it was cleared.

reset

@Stability(value=Experimental)
public void reset()

(experimental) Reset the task so it no longer has any commands.

say

@Stability(value=Experimental)
public void say(@NotNull
                                               String message,
                                               @Nullable
                                               TaskStepOptions options)

(experimental) Say something.

Parameters:

message - Your message. This parameter is required.

options - Options.

say

@Stability(value=Experimental)
public void say(@NotNull
                                               String message)

(experimental) Say something.

Parameters:

message - Your message. This parameter is required.

spawn

@Stability(value=Experimental)
public void spawn(@NotNull
                                                 Task subtask,
                                                 @Nullable
                                                 TaskStepOptions options)

(experimental) Spawns a sub-task.

Parameters:

subtask - The subtask to execute. This parameter is required.

options -

spawn

@Stability(value=Experimental)
public void spawn(@NotNull
                                                 Task subtask)

(experimental) Spawns a sub-task.

Parameters:

subtask - The subtask to execute. This parameter is required.

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

(experimental) Task name.

getSteps

@Stability(value=Experimental)
 @NotNull
public List<TaskStep> getSteps()

(experimental) Returns an immutable copy of all the step specifications of the task.

getCondition

@Stability(value=Experimental)
 @Nullable
public String getCondition()

(experimental) A command to execute which determines if the task should be skipped.

If it returns a zero exit code, the task will not be executed.

getDescription

@Stability(value=Experimental)
 @Nullable
public String getDescription()

(experimental) Returns the description of this task.

Sets the description of this task.

setDescription

@Stability(value=Experimental)
public void setDescription(@Nullable
                                                          String value)

(experimental) Returns the description of this task.

Sets the description of this task.