Package io.github.cdklabs.projen

Class YamlFileOptions.Builder

java.lang.Object

io.github.cdklabs.projen.YamlFileOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<YamlFileOptions>

Enclosing interface:

YamlFileOptions

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

A builder for YamlFileOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
YamlFileOptions	build()	Builds the configured instance.
YamlFileOptions.Builder	committed(Boolean committed)	Sets the value of FileBaseOptions.getCommitted()
YamlFileOptions.Builder	editGitignore(Boolean editGitignore)	Sets the value of FileBaseOptions.getEditGitignore()
YamlFileOptions.Builder	executable(Boolean executable)	Sets the value of FileBaseOptions.getExecutable()
YamlFileOptions.Builder	lineWidth(Number lineWidth)	Sets the value of YamlFileOptions.getLineWidth()
YamlFileOptions.Builder	marker(Boolean marker)	Sets the value of FileBaseOptions.getMarker()
YamlFileOptions.Builder	obj(Object obj)	Sets the value of ObjectFileOptions.getObj()
YamlFileOptions.Builder	omitEmpty(Boolean omitEmpty)	Sets the value of ObjectFileOptions.getOmitEmpty()
YamlFileOptions.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

lineWidth

@Stability(Experimental)
public YamlFileOptions.Builder lineWidth(Number lineWidth)

Sets the value of YamlFileOptions.getLineWidth()

Parameters:

lineWidth - Maximum line width (set to 0 to disable folding).

Returns:

this

obj

@Stability(Experimental)
public YamlFileOptions.Builder obj(Object obj)

Sets the value of ObjectFileOptions.getObj()

Parameters:

obj - The object that will be serialized. You can modify the object's contents before synthesis. Serialization of the object is similar to JSON.stringify with few enhancements:

• values that are functions will be called during synthesis and the result will be serialized - this allow to have lazy values.
• Set will be converted to array
• Map will be converted to a plain object ({ key: value, ... }})
• RegExp without flags will be converted to string representation of the source

Returns:

this

omitEmpty

@Stability(Experimental)
public YamlFileOptions.Builder omitEmpty(Boolean omitEmpty)

Sets the value of ObjectFileOptions.getOmitEmpty()

Parameters:

omitEmpty - Omits empty objects and arrays.

Returns:

this

committed

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

Sets the value of FileBaseOptions.getEditGitignore()

Parameters:

editGitignore - Update the project's .gitignore file.

Returns:

this

executable

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of YamlFileOptions

Throws:

NullPointerException - if any required attribute was not provided