io.github.cdklabs.projen

Class Tasks

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.Tasks

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.450Z")
 @Stability(value=Experimental)
public class Tasks
extends Component

(experimental) Defines project tasks.

Tasks extend the projen CLI by adding subcommands to it. Task definitions are synthesized into .projen/tasks.json.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	MANIFEST_FILE (experimental) The project-relative path of the tasks manifest file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Tasks(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Tasks(software.amazon.jsii.JsiiObjectRef objRef)
	Tasks(Project project)

Method Summary

Modifier and Type	Method and Description
void	addEnvironment(String name, String value) (experimental) Adds global environment.
Task	addTask(String name) (experimental) Adds a task to a project.
Task	addTask(String name, TaskOptions options) (experimental) Adds a task to a project.
List<Task>	getAll() (experimental) All tasks.
Map<String,String>	getEnv() (experimental) Returns a copy of the currently global environment for this project.
Task	removeTask(String name) (experimental) Removes a task from a project.
Task	tryFind(String name) (experimental) Finds a task by name.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize, synthesize

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

Field Detail

MANIFEST_FILE

@Stability(value=Experimental)
public static final String MANIFEST_FILE

(experimental) The project-relative path of the tasks manifest file.

Constructor Detail

Tasks

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

Tasks

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

Tasks

@Stability(value=Experimental)
public Tasks(@NotNull
                                            Project project)

Parameters:

project - This parameter is required.

Method Detail

addEnvironment

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

(experimental) Adds global environment.

Parameters:

name - Environment variable name. This parameter is required.

value - Value. This parameter is required.

addTask

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

(experimental) Adds a task to a project.

Parameters:

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

options - Task options.

addTask

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

(experimental) Adds a task to a project.

Parameters:

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

removeTask

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

(experimental) Removes a task from a project.

Parameters:

name - The name of the task to remove. This parameter is required.

Returns:

The `Task` that was removed, otherwise `undefined`.

tryFind

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

(experimental) Finds a task by name.

Returns undefined if the task cannot be found.

Parameters:

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

getAll

@Stability(value=Experimental)
 @NotNull
public List<Task> getAll()

(experimental) All tasks.

getEnv

@Stability(value=Experimental)
 @NotNull
public Map<String,String> getEnv()

(experimental) Returns a copy of the currently global environment for this project.