io.github.cdklabs.projen

Class TextFile

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.TextFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

PullRequestTemplate

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

(experimental) A text file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextFile.Builder (experimental) A fluent builder for TextFile.

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields inherited from class io.github.cdklabs.projen.FileBase

PROJEN_MARKER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TextFile(software.amazon.jsii.JsiiObjectRef objRef)
	TextFile(Project project, String filePath) (experimental) Defines a text file.
	TextFile(Project project, String filePath, TextFileOptions options) (experimental) Defines a text file.

Method Summary

Modifier and Type	Method and Description
void	addLine(String line) (experimental) Adds a line to the text file.
protected String	synthesizeContent(IResolver _) (experimental) Implemented by derived classes and returns the contents of the file to emit.

Methods inherited from class io.github.cdklabs.projen.FileBase

getAbsolutePath, getExecutable, getPath, getReadonly, setExecutable, setReadonly, synthesize

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

Constructor Detail

TextFile

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

TextFile

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

TextFile

@Stability(value=Experimental)
public TextFile(@NotNull
                                               Project project,
                                               @NotNull
                                               String filePath,
                                               @Nullable
                                               TextFileOptions options)

(experimental) Defines a text file.

Parameters:

project - The project. This parameter is required.

filePath - File path. This parameter is required.

options - Options.

TextFile

@Stability(value=Experimental)
public TextFile(@NotNull
                                               Project project,
                                               @NotNull
                                               String filePath)

(experimental) Defines a text file.

Parameters:

project - The project. This parameter is required.

filePath - File path. This parameter is required.

Method Detail

addLine

@Stability(value=Experimental)
public void addLine(@NotNull
                                                   String line)

(experimental) Adds a line to the text file.

Parameters:

line - the line to add (can use tokens). This parameter is required.

synthesizeContent

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

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

Specified by:

synthesizeContent in class FileBase

Parameters:

_ - This parameter is required.

Returns:

the content to synthesize or undefined to skip the file