io.github.cdklabs.projen.web

Class ReactTypeDef.Builder

java.lang.Object

io.github.cdklabs.projen.web.ReactTypeDef.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ReactTypeDef>

Enclosing class:

ReactTypeDef

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

(experimental) A fluent builder for ReactTypeDef.

Method Summary

Modifier and Type	Method and Description
ReactTypeDef	build()
ReactTypeDef.Builder	committed(Boolean committed) (experimental) Indicates whether this file should be committed to git or ignored.
static ReactTypeDef.Builder	create(ReactTypeScriptProject project, String filePath)
ReactTypeDef.Builder	editGitignore(Boolean editGitignore) (experimental) Update the project's .gitignore file.
ReactTypeDef.Builder	executable(Boolean executable) (experimental) Whether the generated file should be marked as executable.
ReactTypeDef.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 ReactTypeDef.Builder create(ReactTypeScriptProject project,
                                                                         String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Returns:

a new instance of ReactTypeDef.Builder.

committed

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

build

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

Specified by:

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