SampleReadme.Builder (io.github.cdklabs:projen 0.80.15 API)

java.lang.Object
- io.github.cdklabs.projen.SampleReadme.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SampleReadme>

Enclosing class:

SampleReadme
```
@Stability(Experimental)
public static final class SampleReadme.Builder
extends Object
implements software.amazon.jsii.Builder<SampleReadme>
```
(experimental) A fluent builder for SampleReadme.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SampleReadme`	`build()`
`SampleReadme.Builder`	`contents(String contents)`	(experimental) The contents.
`static SampleReadme.Builder`	`create(Project project)`
`SampleReadme.Builder`	`filename(String filename)`	(experimental) The name of the README.md file.

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 SampleReadme.Builder create(Project project)
```
    Parameters:
    
    project - This parameter is required.
    
    Returns:
    
    a new instance of SampleReadme.Builder.
  - contents
```
@Stability(Experimental)
public SampleReadme.Builder contents(String contents)
```
    (experimental) The contents.
    Default: "# replace this"
    
    Parameters:
    
    contents - The contents. This parameter is required.
    
    Returns:
    
    this
  - filename
```
@Stability(Experimental)
public SampleReadme.Builder filename(String filename)
```
    (experimental) The name of the README.md file.
    Default: "README.md"
    Example:
    
    "readme.md"
    Parameters:
    
    filename - The name of the README.md file. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(Experimental)
public SampleReadme build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<SampleReadme>
    
    Returns:
    
    a newly built instance of SampleReadme.