io.github.cdklabs.projen

Class SampleDirOptions.Builder

java.lang.Object

io.github.cdklabs.projen.SampleDirOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SampleDirOptions>

Enclosing interface:

SampleDirOptions

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

A builder for SampleDirOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SampleDirOptions	build() Builds the configured instance.
SampleDirOptions.Builder	files(Map<String,String> files) Sets the value of SampleDirOptions.getFiles()
SampleDirOptions.Builder	sourceDir(String sourceDir) Sets the value of SampleDirOptions.getSourceDir()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

files

@Stability(value=Experimental)
public SampleDirOptions.Builder files(Map<String,String> files)

Sets the value of SampleDirOptions.getFiles()

Parameters:

files - 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).

Returns:

this

sourceDir

@Stability(value=Experimental)
public SampleDirOptions.Builder sourceDir(String sourceDir)

Sets the value of SampleDirOptions.getSourceDir()

Parameters:

sourceDir - 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') });
                  

Returns:

this

build

@Stability(value=Experimental)
public SampleDirOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SampleDirOptions

Throws:

NullPointerException - if any required attribute was not provided