Package io.github.cdklabs.projen

Class Makefile.Builder

java.lang.Object

io.github.cdklabs.projen.Makefile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Makefile>

Enclosing class:

Makefile

@Stability(Experimental)
public static final class Makefile.Builder
extends Object
implements software.amazon.jsii.Builder<Makefile>

(experimental) A fluent builder for Makefile.

Method Summary

Modifier and Type	Method	Description
Makefile.Builder	all(List<String> all)	(experimental) List of targets to build when Make is invoked without specifying any targets.
Makefile	build()
Makefile.Builder	committed(Boolean committed)	(experimental) Indicates whether this file should be committed to git or ignored.
static Makefile.Builder	create(Project project, String filePath)
Makefile.Builder	editGitignore(Boolean editGitignore)	(experimental) Update the project's .gitignore file.
Makefile.Builder	executable(Boolean executable)	(experimental) Whether the generated file should be marked as executable.
Makefile.Builder	marker(Boolean marker)	(experimental) Adds the projen marker to the file.
Makefile.Builder	readonly(Boolean readonly)	(experimental) Whether the generated file should be readonly.
Makefile.Builder	rules(List<? extends Rule> rules)	(experimental) Rules to include in the Makefile.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static Makefile.Builder create(Project project,
                                      String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Returns:

a new instance of Makefile.Builder.

committed

@Stability(Experimental)
public Makefile.Builder committed(Boolean committed)

(experimental) Indicates whether this file should be committed to git or ignored.

By default, all generated files are committed and anti-tamper is used to protect against manual modifications.

Default: true

Parameters:

committed - Indicates whether this file should be committed to git or ignored. This parameter is required.

Returns:

this

editGitignore

@Stability(Experimental)
public Makefile.Builder editGitignore(Boolean editGitignore)

(experimental) Update the project's .gitignore file.

Default: true

Parameters:

editGitignore - Update the project's .gitignore file. This parameter is required.

Returns:

this

executable

@Stability(Experimental)
public Makefile.Builder executable(Boolean executable)

(experimental) Whether the generated file should be marked as executable.

Default: false

Parameters:

executable - Whether the generated file should be marked as executable. This parameter is required.

Returns:

this

marker

@Stability(Experimental)
public Makefile.Builder marker(Boolean marker)

(experimental) Adds the projen marker to the file.

Default: - marker will be included as long as the project is not ejected

Parameters:

marker - Adds the projen marker to the file. This parameter is required.

Returns:

this

readonly

@Stability(Experimental)
public Makefile.Builder readonly(Boolean readonly)

(experimental) Whether the generated file should be readonly.

Default: true

Parameters:

readonly - Whether the generated file should be readonly. This parameter is required.

Returns:

this

all

@Stability(Experimental)
public Makefile.Builder all(List<String> all)

(experimental) List of targets to build when Make is invoked without specifying any targets.

Default: []

Parameters:

all - List of targets to build when Make is invoked without specifying any targets. This parameter is required.

Returns:

this

rules

@Stability(Experimental)
public Makefile.Builder rules(List<? extends Rule> rules)

(experimental) Rules to include in the Makefile.

Default: []

Parameters:

rules - Rules to include in the Makefile. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public Makefile build()

Specified by:

build in interface software.amazon.jsii.Builder<Makefile>

Returns:

a newly built instance of Makefile.