Package io.github.cdklabs.projen

Interface JsonFileOptions

All Superinterfaces:

FileBaseOptions, software.amazon.jsii.JsiiSerializable, ObjectFileOptions

All Known Implementing Classes:

JsonFileOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.770Z")
@Stability(Experimental)
public interface JsonFileOptions
extends software.amazon.jsii.JsiiSerializable, ObjectFileOptions

(experimental) Options for JsonFile.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JsonFileOptions.Builder	builder()
default Boolean	getAllowComments()	(experimental) Allow the use of comments in this file.
default Boolean	getNewline()	(experimental) Adds a newline at the end of the file.

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

getCommitted, getEditGitignore, getExecutable, getMarker, getReadonly

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getObj, getOmitEmpty

Method Detail

getAllowComments

@Stability(Experimental)
@Nullable
default Boolean getAllowComments()

(experimental) Allow the use of comments in this file.

Default: - false for .json files, true for .json5 and .jsonc files

getNewline

@Stability(Experimental)
@Nullable
default Boolean getNewline()

(experimental) Adds a newline at the end of the file.

Default: true

builder

@Stability(Experimental)
static JsonFileOptions.Builder builder()

Returns:

a JsonFileOptions.Builder of JsonFileOptions