io.github.cdklabs.projen

Class SampleDir

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.SampleDir

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

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

(experimental) Renders the given files into the directory if the directory does not exist.

Use this to create sample code files

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SampleDir(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SampleDir(software.amazon.jsii.JsiiObjectRef objRef)
	SampleDir(Project project, String dir, SampleDirOptions options) (experimental) Create sample files in the given directory if the given directory does not exist.

Method Summary

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

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

SampleDir

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

SampleDir

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

SampleDir

@Stability(value=Experimental)
public SampleDir(@NotNull
                                                Project project,
                                                @NotNull
                                                String dir,
                                                @NotNull
                                                SampleDirOptions options)

(experimental) Create sample files in the given directory if the given directory does not exist.

Parameters:

project - Parent project to add files to. This parameter is required.

dir - directory to add files to. This parameter is required.

options - options for which files to create. This parameter is required.

Method Detail

synthesize

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

(experimental) Synthesizes files to the project output directory.

Overrides:

synthesize in class Component