io.github.cdklabs.projen

Interface FileBaseOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IniFileOptions, JsonFileOptions, MakefileOptions, ObjectFileOptions, ReactTypeDefOptions, TextFileOptions, TomlFileOptions, XmlFileOptions, YamlFileOptions

All Known Implementing Classes:

FileBaseOptions.Jsii$Proxy, IniFileOptions.Jsii$Proxy, JsonFileOptions.Jsii$Proxy, MakefileOptions.Jsii$Proxy, ObjectFileOptions.Jsii$Proxy, ReactTypeDefOptions.Jsii$Proxy, TextFileOptions.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.396Z")
 @Stability(value=Experimental)
public interface FileBaseOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FileBaseOptions.Builder	builder()
default Boolean	getCommitted() (experimental) Indicates whether this file should be committed to git or ignored.
default Boolean	getEditGitignore() (experimental) Update the project's .gitignore file.
default Boolean	getExecutable() (experimental) Whether the generated file should be marked as executable.
default Boolean	getReadonly() (experimental) Whether the generated file should be readonly.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommitted

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

(experimental) Indicates whether this file should be committed to git or ignored.

By default, all generated files are committed and anti-tamper is used to protect against manual modifications.

Default: true

getEditGitignore

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

(experimental) Update the project's .gitignore file.

Default: true

getExecutable

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

(experimental) Whether the generated file should be marked as executable.

Default: false

getReadonly

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

(experimental) Whether the generated file should be readonly.

Default: true

builder

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

Returns:

a FileBaseOptions.Builder of FileBaseOptions