Package io.github.cdklabs.projen

Class Component

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

All Implemented Interfaces:

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

Direct Known Subclasses:

AutoApprove, AutoDiscover, AutoDiscover, AutoDiscoverBase, AutoMerge, AwsCdkDeps, BuildWorkflow, Bundler, Cdk8sDeps, CdkConfig, CdkTasks, CiConfiguration, Circleci, Dependabot, Dependencies, DevContainer, DockerCompose, Eslint, FileBase, GitHub, GithubWorkflow, Gitpod, IntegrationTestBase, Jest, Junit, LambdaExtension, LambdaFunction, LicenseChecker, Logger, MavenCompile, MavenPackaging, MavenSample, Mergify, NextComponent, NodePackage, NpmConfig, Pip, Poetry, PoetryPyproject, Pom, Prettier, ProjectBuild, ProjectTree, ProjenrcFile, Publisher, PullRequestLint, Pytest, PytestSample, PythonSample, ReactComponent, Release, Renovatebot, SampleDir, SampleFile, Setuptools, SourceCode, Stale, Tasks, TaskWorkflowJob, TypescriptConfig, UpgradeDependencies, Venv, Version, VsCode, VsCodeLaunchConfig, VsCodeRecommendedExtensions, VsCodeSettings, Yarnrc

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.717Z")
@Stability(Experimental)
public class Component
extends software.constructs.Construct

(experimental) Represents a project component.

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, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Project	getProject()
static Boolean	isComponent(Object x)	(experimental) Test whether the given construct is a component.
void	postSynthesize()	(experimental) Called after synthesis.
void	preSynthesize()	(experimental) Called before synthesis.
void	synthesize()	(experimental) Synthesizes files to the project output directory.

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

Component

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

Component

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

Component

@Stability(Experimental)
public Component(@NotNull
                 software.constructs.IConstruct scope,
                 @Nullable
                 String id)

Parameters:

scope - This parameter is required.

id -

Component

@Stability(Experimental)
public Component(@NotNull
                 software.constructs.IConstruct scope)

Parameters:

scope - This parameter is required.

Method Detail

isComponent

@Stability(Experimental)
@NotNull
public static Boolean isComponent(@NotNull
                                  Object x)

(experimental) Test whether the given construct is a component.

Parameters:

x - This parameter is required.

postSynthesize

@Stability(Experimental)
public void postSynthesize()

(experimental) Called after synthesis.

Order is not guaranteed.

preSynthesize

@Stability(Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

synthesize

@Stability(Experimental)
public void synthesize()

(experimental) Synthesizes files to the project output directory.

getProject

@Stability(Experimental)
@NotNull
public Project getProject()