Package io.github.cdklabs.projen

Class JsonFile

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.JsonFile

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.769Z")
@Stability(Experimental)
public class JsonFile
extends ObjectFile

(experimental) Represents a JSON file.

Nested Class Summary

Nested Classes

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

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	JsonFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	JsonFile(software.amazon.jsii.JsiiObjectRef objRef)
	JsonFile(software.constructs.IConstruct scope, String filePath, JsonFileOptions options)

Method Summary

Modifier and Type	Method	Description
Boolean	getSupportsComments()
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

JsonFile

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

JsonFile

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

JsonFile

@Stability(Experimental)
public JsonFile(@NotNull
                software.constructs.IConstruct scope,
                @NotNull
                String filePath,
                @NotNull
                JsonFileOptions 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

getSupportsComments

@Stability(Experimental)
@NotNull
public Boolean getSupportsComments()