Package io.github.cdklabs.projen

Class YamlFile.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<YamlFile>
    Enclosing class:
    YamlFile
    @Stability(Experimental)
public static final class YamlFile.Builder
extends Object
implements software.amazon.jsii.Builder<YamlFile>
    (experimental) A fluent builder for YamlFile.

    • Method Detail

      • create

        @Stability(Experimental)
public static YamlFile.Builder create​(software.constructs.IConstruct scope,
                                      String filePath)
        Parameters:
        scope - This parameter is required.
        filePath - This parameter is required.
        Returns:
        a new instance of YamlFile.Builder.

      • committed

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

      • marker

        @Stability(Experimental)
public YamlFile.Builder marker​(Boolean marker)
        (experimental) Adds the projen marker to the file.

        Default: - marker will be included as long as the project is not ejected

        Parameters:
        marker - Adds the projen marker to the file. This parameter is required.
        Returns:
        this

      • readonly

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

      • obj

        @Stability(Experimental)
public YamlFile.Builder obj​(Object obj)
        (experimental) 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

        Default: {} an empty object (use `file.obj` to mutate).

        Parameters:
        obj - The object that will be serialized. You can modify the object's contents before synthesis. This parameter is required.
        Returns:
        this

      • omitEmpty

        @Stability(Experimental)
public YamlFile.Builder omitEmpty​(Boolean omitEmpty)
        (experimental) Omits empty objects and arrays.

        Default: false

        Parameters:
        omitEmpty - Omits empty objects and arrays. This parameter is required.
        Returns:
        this

      • lineWidth

        @Stability(Experimental)
public YamlFile.Builder lineWidth​(Number lineWidth)
        (experimental) Maximum line width (set to 0 to disable folding).

        Default: - 0

        Parameters:
        lineWidth - Maximum line width (set to 0 to disable folding). This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public YamlFile build()
        Specified by:
        build in interface software.amazon.jsii.Builder<YamlFile>
        Returns:
        a newly built instance of YamlFile.