Package io.github.cdklabs.projen

Class YamlFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.ObjectFile

io.github.cdklabs.projen.YamlFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.819Z")
@Stability(Experimental)
public class YamlFile
extends ObjectFile

(experimental) Represents a YAML file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlFile.Builder	(experimental) A fluent builder for YamlFile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	YamlFile(software.amazon.jsii.JsiiObjectRef objRef)
	YamlFile(software.constructs.IConstruct scope, String filePath, YamlFileOptions options)

Method Summary

Modifier and Type	Method	Description
Number	getLineWidth()	(experimental) Maximum line width (set to 0 to disable folding).
void	setLineWidth(Number value)	(experimental) Maximum line width (set to 0 to disable folding).
protected String	synthesizeContent(IResolver resolver)	(experimental) Implemented by derived classes and returns the contents of the file to emit.

Methods inherited from class io.github.cdklabs.projen.ObjectFile

addDeletionOverride, addOverride, addToArray, getOmitEmpty, patch

Methods inherited from class io.github.cdklabs.projen.FileBase

getAbsolutePath, getChanged, getExecutable, getMarker, getPath, getReadonly, setExecutable, setReadonly, synthesize

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

YamlFile

protected YamlFile(software.amazon.jsii.JsiiObjectRef objRef)

YamlFile

protected YamlFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

YamlFile

@Stability(Experimental)
public YamlFile(@NotNull
                software.constructs.IConstruct scope,
                @NotNull
                String filePath,
                @NotNull
                YamlFileOptions options)

Parameters:

scope - This parameter is required.

filePath - This parameter is required.

options - This parameter is required.

Method Detail

synthesizeContent

@Stability(Experimental)
@Nullable
protected String synthesizeContent(@NotNull
                                   IResolver resolver)

(experimental) Implemented by derived classes and returns the contents of the file to emit.

Overrides:

synthesizeContent in class ObjectFile

Parameters:

resolver - This parameter is required.

Returns:

the content to synthesize or undefined to skip the file

getLineWidth

@Stability(Experimental)
@NotNull
public Number getLineWidth()

(experimental) Maximum line width (set to 0 to disable folding).

setLineWidth

@Stability(Experimental)
public void setLineWidth(@NotNull
                         Number value)

(experimental) Maximum line width (set to 0 to disable folding).