Package io.github.cdklabs.projen

Class SampleFileOptions.Builder

java.lang.Object

io.github.cdklabs.projen.SampleFileOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SampleFileOptions>

Enclosing interface:

SampleFileOptions

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

A builder for SampleFileOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SampleFileOptions	build()	Builds the configured instance.
SampleFileOptions.Builder	contents(String contents)	Sets the value of SampleFileOptions.getContents()
SampleFileOptions.Builder	sourcePath(String sourcePath)	Sets the value of SampleFileOptions.getSourcePath()

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

contents

@Stability(Experimental)
public SampleFileOptions.Builder contents(String contents)

Sets the value of SampleFileOptions.getContents()

Parameters:

contents - The contents of the file to write.

Returns:

this

sourcePath

@Stability(Experimental)
public SampleFileOptions.Builder sourcePath(String sourcePath)

Sets the value of SampleFileOptions.getSourcePath()

Parameters:

sourcePath - Absolute path to a file to copy the contents from (does not need to be a text file). 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 SampleFile(this, 'assets/icon.png', { source: path.join(__dirname, '..', 'sample-assets', 'icon.png') });
                   

Returns:

this

build

@Stability(Experimental)
public SampleFileOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SampleFileOptions

Throws:

NullPointerException - if any required attribute was not provided