FileBaseOptions (io.github.cdklabs:projen 0.80.15 API)

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.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.752Z")
@Stability(Experimental)
public interface FileBaseOptions
extends software.amazon.jsii.JsiiSerializable
```

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	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`	`getMarker()`	(experimental) Adds the projen marker to the file.
`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(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(Experimental)
@Nullable
default Boolean getEditGitignore()
```
    (experimental) Update the project's .gitignore file.
    Default: true
  - getExecutable
```
@Stability(Experimental)
@Nullable
default Boolean getExecutable()
```
    (experimental) Whether the generated file should be marked as executable.
    Default: false
  - getMarker
```
@Stability(Experimental)
@Nullable
default Boolean getMarker()
```
    (experimental) Adds the projen marker to the file.
    Default: - marker will be included as long as the project is not ejected
  - getReadonly
```
@Stability(Experimental)
@Nullable
default Boolean getReadonly()
```
    (experimental) Whether the generated file should be readonly.
    Default: true
  - builder
```
@Stability(Experimental)
static FileBaseOptions.Builder builder()
```
    Returns:
    
    a FileBaseOptions.Builder of FileBaseOptions