Package io.github.cdklabs.projen

Class IgnoreFile.Builder

java.lang.Object

io.github.cdklabs.projen.IgnoreFile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<IgnoreFile>

Enclosing class:

IgnoreFile

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

(experimental) A fluent builder for IgnoreFile.

Method Summary

Modifier and Type	Method	Description
IgnoreFile	build()
static IgnoreFile.Builder	create(Project project, String filePath)
IgnoreFile.Builder	filterCommentLines(Boolean filterCommentLines)	(experimental) Filter out comment lines?
IgnoreFile.Builder	filterEmptyLines(Boolean filterEmptyLines)	(experimental) Filter out blank/empty lines?
IgnoreFile.Builder	ignorePatterns(List<String> ignorePatterns)	(experimental) Patterns to add to the ignore 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 IgnoreFile.Builder create(Project project,
                                        String filePath)

Parameters:

project - The project to tie this file to. This parameter is required.

filePath -

• the relative path in the project to put the file.

This parameter is required.

Returns:

a new instance of IgnoreFile.Builder.

filterCommentLines

@Stability(Experimental)
public IgnoreFile.Builder filterCommentLines(Boolean filterCommentLines)

(experimental) Filter out comment lines?

Default: true

Parameters:

filterCommentLines - Filter out comment lines?. This parameter is required.

Returns:

this

filterEmptyLines

@Stability(Experimental)
public IgnoreFile.Builder filterEmptyLines(Boolean filterEmptyLines)

(experimental) Filter out blank/empty lines?

Default: true

Parameters:

filterEmptyLines - Filter out blank/empty lines?. This parameter is required.

Returns:

this

ignorePatterns

@Stability(Experimental)
public IgnoreFile.Builder ignorePatterns(List<String> ignorePatterns)

(experimental) Patterns to add to the ignore file.

Default: []

Parameters:

ignorePatterns - Patterns to add to the ignore file. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public IgnoreFile build()

Specified by:

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

Returns:

a newly built instance of IgnoreFile.