io.github.cdklabs.projen

Class YamlFile.Builder

java.lang.Object

io.github.cdklabs.projen.YamlFile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<YamlFile>

Enclosing class:

YamlFile

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

(experimental) A fluent builder for YamlFile.

Method Summary

Modifier and Type	Method and Description
YamlFile	build()
YamlFile.Builder	committed(Boolean committed) (experimental) Indicates whether this file should be committed to git or ignored.
static YamlFile.Builder	create(Project project, String filePath)
YamlFile.Builder	editGitignore(Boolean editGitignore) (experimental) Update the project's .gitignore file.
YamlFile.Builder	executable(Boolean executable) (experimental) Whether the generated file should be marked as executable.
YamlFile.Builder	marker(Boolean marker) (experimental) Adds the projen marker to the file.
YamlFile.Builder	obj(Object obj) (experimental) The object that will be serialized.
YamlFile.Builder	omitEmpty(Boolean omitEmpty) (experimental) Omits empty objects and arrays.
YamlFile.Builder	readonly(Boolean readonly) (experimental) Whether the generated file should be readonly.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static YamlFile.Builder create(Project project,
                                                                     String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Returns:

a new instance of YamlFile.Builder.

committed

@Stability(value=Experimental)
public YamlFile.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(value=Experimental)
public YamlFile.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(value=Experimental)
public YamlFile.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

readonly

@Stability(value=Experimental)
public YamlFile.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

marker

@Stability(value=Experimental)
public YamlFile.Builder marker(Boolean marker)

(experimental) Adds the projen marker to the file.

Default: true

Parameters:

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

Returns:

this

obj

@Stability(value=Experimental)
public YamlFile.Builder obj(Object obj)

(experimental) The object that will be serialized.

You can modify the object's contents before synthesis.

Default: {} an empty object (use `file.obj` to mutate).

Parameters:

obj - The object that will be serialized. This parameter is required.

Returns:

this

omitEmpty

@Stability(value=Experimental)
public YamlFile.Builder omitEmpty(Boolean omitEmpty)

(experimental) Omits empty objects and arrays.

Default: false

Parameters:

omitEmpty - Omits empty objects and arrays. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public YamlFile build()

Specified by:

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