Package io.github.cdklabs.projen.github

Class SemanticTitleOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.SemanticTitleOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SemanticTitleOptions>

Enclosing interface:

SemanticTitleOptions

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

A builder for SemanticTitleOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SemanticTitleOptions	build()	Builds the configured instance.
SemanticTitleOptions.Builder	requireScope(Boolean requireScope)	Sets the value of SemanticTitleOptions.getRequireScope()
SemanticTitleOptions.Builder	types(List<String> types)	Sets the value of SemanticTitleOptions.getTypes()

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

requireScope

@Stability(Experimental)
public SemanticTitleOptions.Builder requireScope(Boolean requireScope)

Sets the value of SemanticTitleOptions.getRequireScope()

Parameters:

requireScope - Configure that a scope must always be provided. e.g. feat(ui), fix(core)

Returns:

this

types

@Stability(Experimental)
public SemanticTitleOptions.Builder types(List<String> types)

Sets the value of SemanticTitleOptions.getTypes()

Parameters:

types - Configure a list of commit types that are allowed.

Returns:

this

build

@Stability(Experimental)
public SemanticTitleOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SemanticTitleOptions

Throws:

NullPointerException - if any required attribute was not provided