Package io.github.cdklabs.projen

Class TextFileOptions.Builder

java.lang.Object

io.github.cdklabs.projen.TextFileOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TextFileOptions>

Enclosing interface:

TextFileOptions

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

A builder for TextFileOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TextFileOptions	build()	Builds the configured instance.
TextFileOptions.Builder	committed(Boolean committed)	Sets the value of FileBaseOptions.getCommitted()
TextFileOptions.Builder	editGitignore(Boolean editGitignore)	Sets the value of FileBaseOptions.getEditGitignore()
TextFileOptions.Builder	executable(Boolean executable)	Sets the value of FileBaseOptions.getExecutable()
TextFileOptions.Builder	lines(List<String> lines)	Sets the value of TextFileOptions.getLines()
TextFileOptions.Builder	marker(Boolean marker)	Sets the value of FileBaseOptions.getMarker()
TextFileOptions.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

lines

@Stability(Experimental)
public TextFileOptions.Builder lines(List<String> lines)

Sets the value of TextFileOptions.getLines()

Parameters:

lines - The contents of the text file. You can use addLine() to append lines.

Returns:

this

committed

@Stability(Experimental)
public TextFileOptions.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 TextFileOptions.Builder editGitignore(Boolean editGitignore)

Sets the value of FileBaseOptions.getEditGitignore()

Parameters:

editGitignore - Update the project's .gitignore file.

Returns:

this

executable

@Stability(Experimental)
public TextFileOptions.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 TextFileOptions.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 TextFileOptions.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 TextFileOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TextFileOptions

Throws:

NullPointerException - if any required attribute was not provided