io.github.cdklabs.projen

Class ObjectFile

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.ObjectFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

IniFile, JsonFile, TomlFile, XmlFile, YamlFile

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.416Z")
 @Stability(value=Experimental)
public abstract class ObjectFile
extends FileBase

(experimental) Represents an Object file.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

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

PROJEN_MARKER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ObjectFile(software.amazon.jsii.JsiiObjectRef objRef)
protected	ObjectFile(Project project, String filePath, ObjectFileOptions options)

Method Summary

Modifier and Type	Method and Description
void	addDeletionOverride(String path) (experimental) Syntactic sugar for `addOverride(path, undefined)`.
void	addOverride(String path, Object value) (experimental) Adds an override to the synthesized object file.
Boolean	getMarker() (experimental) Indicates if the projen marker JSON-comment will be added to the output object.
Boolean	getOmitEmpty() (experimental) Indicates if empty objects and arrays are omitted from the output object.
void	setMarker(Boolean value) (experimental) Indicates if the projen marker JSON-comment will be added to the output object.
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.FileBase

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

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

getProject, postSynthesize, preSynthesize

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ObjectFile

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

ObjectFile

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

ObjectFile

@Stability(value=Experimental)
protected ObjectFile(@NotNull
                                                    Project project,
                                                    @NotNull
                                                    String filePath,
                                                    @NotNull
                                                    ObjectFileOptions options)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

options - This parameter is required.

Method Detail

addDeletionOverride

@Stability(value=Experimental)
public void addDeletionOverride(@NotNull
                                                               String path)

(experimental) Syntactic sugar for `addOverride(path, undefined)`.

Parameters:

path - The path of the value to delete. This parameter is required.

addOverride

@Stability(value=Experimental)
public void addOverride(@NotNull
                                                       String path,
                                                       @NotNull
                                                       Object value)

(experimental) Adds an override to the synthesized object file.

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

 // Example automatically generated from non-compiling source. May contain errors.
 project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
 project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);
 

would add the overrides

 "compilerOptions": {
    "alwaysStrict": true,
    "lib": [
      "dom",
      "dom.iterable",
      "esnext"
    ]
    ...
 }
 ...
 

Parameters:

path - - The path of the property, you can use dot notation to override values in complex types. This parameter is required.

value - - The value. This parameter is required.

synthesizeContent

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

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

Specified by:

synthesizeContent in class FileBase

Parameters:

resolver - This parameter is required.

Returns:

the content to synthesize or undefined to skip the file

getOmitEmpty

@Stability(value=Experimental)
 @NotNull
public Boolean getOmitEmpty()

(experimental) Indicates if empty objects and arrays are omitted from the output object.

getMarker

@Stability(value=Experimental)
 @NotNull
public Boolean getMarker()

(experimental) Indicates if the projen marker JSON-comment will be added to the output object.

setMarker

@Stability(value=Experimental)
public void setMarker(@NotNull
                                                     Boolean value)

(experimental) Indicates if the projen marker JSON-comment will be added to the output object.