io.github.cdklabs.projen

Class FileBase

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

GitAttributesFile, IgnoreFile, License, Makefile, ObjectFile, ReactTypeDef, RequirementsFile, SetupPy, TextFile

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

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROJEN_MARKER (experimental) The marker to embed in files in order to identify them as projen files.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAbsolutePath() (experimental) The absolute path of this file.
Boolean	getExecutable() (experimental) Indicates if the file should be marked as executable.
String	getPath() (experimental) The file path, relative to the project root.
Boolean	getReadonly() (experimental) Indicates if the file should be read-only or read-write.
void	setExecutable(Boolean value) (experimental) Indicates if the file should be marked as executable.
void	setReadonly(Boolean value) (experimental) Indicates if the file should be read-only or read-write.
void	synthesize() (experimental) Writes the file to the project's output directory.
protected abstract 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.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

Field Detail

PROJEN_MARKER

@Stability(value=Experimental)
public static final String PROJEN_MARKER

(experimental) The marker to embed in files in order to identify them as projen files.

This marker is used to prune these files before synthesis.

Constructor Detail

FileBase

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

FileBase

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

FileBase

@Stability(value=Experimental)
protected FileBase(@NotNull
                                                  Project project,
                                                  @NotNull
                                                  String filePath,
                                                  @Nullable
                                                  FileBaseOptions options)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

options -

FileBase

@Stability(value=Experimental)
protected FileBase(@NotNull
                                                  Project project,
                                                  @NotNull
                                                  String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Method Detail

synthesize

@Stability(value=Experimental)
public void synthesize()

(experimental) Writes the file to the project's output directory.

Overrides:

synthesize in class Component

synthesizeContent

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

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

Parameters:

resolver - Call `resolver.resolve(obj)` on any objects in order to resolve token functions. This parameter is required.

Returns:

the content to synthesize or undefined to skip the file

getAbsolutePath

@Stability(value=Experimental)
 @NotNull
public String getAbsolutePath()

(experimental) The absolute path of this file.

getPath

@Stability(value=Experimental)
 @NotNull
public String getPath()

(experimental) The file path, relative to the project root.

getExecutable

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

(experimental) Indicates if the file should be marked as executable.

setExecutable

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

(experimental) Indicates if the file should be marked as executable.

getReadonly

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

(experimental) Indicates if the file should be read-only or read-write.

setReadonly

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

(experimental) Indicates if the file should be read-only or read-write.