Package io.github.cdklabs.projen

Class SampleFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.SampleFile

All Implemented Interfaces:

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

Direct Known Subclasses:

SampleReadme

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

(experimental) Produces a file with the given contents but only once, if the file doesn't already exist.

Use this for creating example code files or other resources.

Nested Class Summary

Nested Classes

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

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
	SampleFile(Project project, String filePath, SampleFileOptions options)	(experimental) Creates a new SampleFile object.
protected	SampleFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SampleFile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	synthesize()	(experimental) Synthesizes files to the project output directory.

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

getProject, isComponent, postSynthesize, preSynthesize

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

SampleFile

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

SampleFile

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

SampleFile

@Stability(Experimental)
public SampleFile(@NotNull
                  Project project,
                  @NotNull
                  String filePath,
                  @NotNull
                  SampleFileOptions options)

(experimental) Creates a new SampleFile object.

Parameters:

project -

• the project to tie this file to.

This parameter is required.

filePath -

• the relative path in the project to put the file.

This parameter is required.

options -

• the options for the file.

This parameter is required.

Method Detail

synthesize

@Stability(Experimental)
public void synthesize()

(experimental) Synthesizes files to the project output directory.

Overrides:

synthesize in class Component