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 for FileBaseOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FileBaseOptions	build()	Builds the configured instance.
FileBaseOptions.Builder	committed(Boolean committed)	Sets the value of FileBaseOptions.getCommitted()
FileBaseOptions.Builder	editGitignore(Boolean editGitignore)	Sets the value of FileBaseOptions.getEditGitignore()
FileBaseOptions.Builder	executable(Boolean executable)	Sets the value of FileBaseOptions.getExecutable()
FileBaseOptions.Builder	marker(Boolean marker)	Sets the value of FileBaseOptions.getMarker()
FileBaseOptions.Builder	readonly(Boolean readonly)	Sets the value of FileBaseOptions.getReadonly()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

committed

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

Sets the value of FileBaseOptions.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 of FileBaseOptions.getEditGitignore()

Parameters:

editGitignore - Update the project's .gitignore file.

Returns:

this

executable

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

Sets the value of FileBaseOptions.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 of FileBaseOptions.getMarker()

Parameters:

marker - Adds the projen marker to the file.

Returns:

this

readonly

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

Sets the value of FileBaseOptions.getReadonly()

Parameters:

readonly - Whether the generated file should be readonly.

Returns:

this

build

@Stability(Experimental)
public FileBaseOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of FileBaseOptions

Throws:

NullPointerException - if any required attribute was not provided