Package io.github.cdklabs.projen

Class ProjenrcFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.ProjenrcFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

Projenrc, Projenrc, Projenrc, Projenrc, ProjenrcJson, ProjenrcTs

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.795Z")
@Stability(Experimental)
public abstract class ProjenrcFile
extends Component

(experimental) A component representing the projen runtime configuration.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProjenrcFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ProjenrcFile(software.amazon.jsii.JsiiObjectRef objRef)
protected	ProjenrcFile(software.constructs.IConstruct scope)
protected	ProjenrcFile(software.constructs.IConstruct scope, String id)

Method Summary

Modifier and Type	Method	Description
abstract String	getFilePath()	(experimental) The path of the projenrc file.
static ProjenrcFile	of(Project project)	(experimental) Returns the Projenrc instance associated with a project or undefined if there is no Projenrc.
void	preSynthesize()	(experimental) Called before synthesis.

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

getProject, isComponent, postSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ProjenrcFile

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

ProjenrcFile

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

ProjenrcFile

@Stability(Experimental)
protected ProjenrcFile(@NotNull
                       software.constructs.IConstruct scope,
                       @Nullable
                       String id)

Parameters:

scope - This parameter is required.

id -

ProjenrcFile

@Stability(Experimental)
protected ProjenrcFile(@NotNull
                       software.constructs.IConstruct scope)

Parameters:

scope - This parameter is required.

Method Detail

of

@Stability(Experimental)
@Nullable
public static ProjenrcFile of(@NotNull
                              Project project)

(experimental) Returns the Projenrc instance associated with a project or undefined if there is no Projenrc.

Parameters:

project - The project. This parameter is required.

Returns:

A Projenrc

preSynthesize

@Stability(Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

Overrides:

preSynthesize in class Component

getFilePath

@Stability(Experimental)
@NotNull
public abstract String getFilePath()

(experimental) The path of the projenrc file.