Package io.github.cdklabs.projen
Class FileBaseOptions.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.FileBaseOptions.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<FileBaseOptions>
- Enclosing interface:
- FileBaseOptions
@Stability(Experimental) public static final class FileBaseOptions.Builder extends Object implements software.amazon.jsii.Builder<FileBaseOptions>
A builder forFileBaseOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FileBaseOptionsbuild()Builds the configured instance.FileBaseOptions.Buildercommitted(Boolean committed)Sets the value ofFileBaseOptions.getCommitted()FileBaseOptions.BuildereditGitignore(Boolean editGitignore)Sets the value ofFileBaseOptions.getEditGitignore()FileBaseOptions.Builderexecutable(Boolean executable)Sets the value ofFileBaseOptions.getExecutable()FileBaseOptions.Buildermarker(Boolean marker)Sets the value ofFileBaseOptions.getMarker()FileBaseOptions.Builderreadonly(Boolean readonly)Sets the value ofFileBaseOptions.getReadonly()
-
-
-
Method Detail
-
committed
@Stability(Experimental) public FileBaseOptions.Builder committed(Boolean committed)
Sets the value ofFileBaseOptions.getCommitted()- Parameters:
committed- 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.- Returns:
this
-
editGitignore
@Stability(Experimental) public FileBaseOptions.Builder editGitignore(Boolean editGitignore)
Sets the value ofFileBaseOptions.getEditGitignore()- Parameters:
editGitignore- Update the project's .gitignore file.- Returns:
this
-
executable
@Stability(Experimental) public FileBaseOptions.Builder executable(Boolean executable)
Sets the value ofFileBaseOptions.getExecutable()- Parameters:
executable- Whether the generated file should be marked as executable.- Returns:
this
-
marker
@Stability(Experimental) public FileBaseOptions.Builder marker(Boolean marker)
Sets the value ofFileBaseOptions.getMarker()- Parameters:
marker- Adds the projen marker to the file.- Returns:
this
-
readonly
@Stability(Experimental) public FileBaseOptions.Builder readonly(Boolean readonly)
Sets the value ofFileBaseOptions.getReadonly()- Parameters:
readonly- Whether the generated file should be readonly.- Returns:
this
-
build
@Stability(Experimental) public FileBaseOptions build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<FileBaseOptions>- Returns:
- a new instance of
FileBaseOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-