SampleDir (io.github.cdklabs:projen 0.80.15 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - io.github.cdklabs.projen.Component
    - - io.github.cdklabs.projen.SampleDir

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
```
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.799Z")
@Stability(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 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
- 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
	`SampleDir(Project project, String dir, SampleDirOptions options)`	(experimental) Create sample files in the given directory if the given directory does not exist.
`protected`	`SampleDir(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`SampleDir(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
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

SampleDir

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

SampleDir

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

SampleDir
```
@Stability(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(Experimental)
public void synthesize()
```
  (experimental) Synthesizes files to the project output directory.
  
  Overrides:
  
  synthesize in class Component