io.github.cdklabs.projen

Interface ObjectFileOptions

All Superinterfaces:

FileBaseOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IniFileOptions, JsonFileOptions, TomlFileOptions, XmlFileOptions, YamlFileOptions

All Known Implementing Classes:

IniFileOptions.Jsii$Proxy, JsonFileOptions.Jsii$Proxy, ObjectFileOptions.Jsii$Proxy, TomlFileOptions.Jsii$Proxy, XmlFileOptions.Jsii$Proxy, YamlFileOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.418Z")
 @Stability(value=Experimental)
public interface ObjectFileOptions
extends software.amazon.jsii.JsiiSerializable, FileBaseOptions

(experimental) Options for `ObjectFile`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectFileOptions.Builder A builder for ObjectFileOptions
static class	ObjectFileOptions.Jsii$Proxy An implementation for ObjectFileOptions

Method Summary

Modifier and Type	Method and Description
static ObjectFileOptions.Builder	builder()
default Boolean	getMarker() (experimental) Adds the projen marker to the file.
default Object	getObj() (experimental) The object that will be serialized.
default Boolean	getOmitEmpty() (experimental) Omits empty objects and arrays.

Methods inherited from interface io.github.cdklabs.projen.FileBaseOptions

getCommitted, getEditGitignore, getExecutable, getReadonly

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMarker

@Stability(value=Experimental)
 @Nullable
default Boolean getMarker()

(experimental) Adds the projen marker to the file.

Default: true

getObj

@Stability(value=Experimental)
 @Nullable
default Object getObj()

(experimental) The object that will be serialized.

You can modify the object's contents before synthesis.

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

getOmitEmpty

@Stability(value=Experimental)
 @Nullable
default Boolean getOmitEmpty()

(experimental) Omits empty objects and arrays.

Default: false

builder

@Stability(value=Experimental)
static ObjectFileOptions.Builder builder()

Specified by:

builder in interface FileBaseOptions

Returns:

a ObjectFileOptions.Builder of ObjectFileOptions