Package io.github.cdklabs.projen

Class SampleDir.Builder

java.lang.Object

io.github.cdklabs.projen.SampleDir.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SampleDir>

Enclosing class:

SampleDir

@Stability(Experimental)
public static final class SampleDir.Builder
extends Object
implements software.amazon.jsii.Builder<SampleDir>

(experimental) A fluent builder for SampleDir.

Method Summary

Modifier and Type	Method	Description
SampleDir	build()
static SampleDir.Builder	create(Project project, String dir)
SampleDir.Builder	files(Map<String,String> files)	(experimental) The files to render into the directory.
SampleDir.Builder	sourceDir(String sourceDir)	(experimental) Absolute path to a directory to copy files from (does not need to be text files).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Experimental)
public static SampleDir.Builder create(Project project,
                                       String dir)

Parameters:

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

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

Returns:

a new instance of SampleDir.Builder.

files

@Stability(Experimental)
public SampleDir.Builder files(Map<String,String> files)

(experimental) The files to render into the directory.

These files get added after any files from source if that option is specified (replacing if names overlap).

Parameters:

files - The files to render into the directory. This parameter is required.

Returns:

this

sourceDir

@Stability(Experimental)
public SampleDir.Builder sourceDir(String sourceDir)

(experimental) Absolute path to a directory to copy files from (does not need to be text files).

If your project is typescript-based and has configured testdir to be a subdirectory of src, sample files should outside of the src directory otherwise they may not be copied. For example:

 new SampleDir(this, 'public', { source: path.join(__dirname, '..', 'sample-assets') });
 

Parameters:

sourceDir - Absolute path to a directory to copy files from (does not need to be text files). This parameter is required.

Returns:

this

build

@Stability(Experimental)
public SampleDir build()

Specified by:

build in interface software.amazon.jsii.Builder<SampleDir>

Returns:

a newly built instance of SampleDir.