rocks.cleancode.conventionalcommit

Class ConventionalCommit.Builder

java.lang.Object

rocks.cleancode.conventionalcommit.ConventionalCommit.Builder

Enclosing class:

ConventionalCommit

public static class ConventionalCommit.Builder
extends Object

Builder to ease conventional commit creation.

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
Builder() Default constructor.

Method Summary

Modifier and Type	Method and Description
ConventionalCommit.Builder	body(String body) Message body.
ConventionalCommit	build() Build the conventional commit with the given values.
ConventionalCommit.Builder	description(String description) Message description.
ConventionalCommit.Builder	exclamation(boolean exclamation) Message with exclamation mark.
ConventionalCommit.Builder	footer(String key, String value) Add footer to message.
ConventionalCommit.Builder	scope(String scope) Message scope.
ConventionalCommit.Builder	type(String type) Message type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default constructor.

Since:

1.1.0

Method Detail

type

public ConventionalCommit.Builder type(String type)

Message type.

Parameters:

type - Message type

Returns:

Current builder instance

Since:

1.1.0

scope

public ConventionalCommit.Builder scope(String scope)

Message scope.

Parameters:

scope - Message scope

Returns:

Current builder instance

Since:

1.1.0

exclamation

public ConventionalCommit.Builder exclamation(boolean exclamation)

Message with exclamation mark.

Parameters:

exclamation - true to set exclamation mark in message, false otherwise

Returns:

Current builder instance

Since:

1.1.0

description

public ConventionalCommit.Builder description(String description)

Message description.

Parameters:

description - Message description

Returns:

Current builder instance

Since:

1.1.0

body

public ConventionalCommit.Builder body(String body)

Message body.

Parameters:

body - Message body

Returns:

Current builder instance

Since:

1.1.0

footer

public ConventionalCommit.Builder footer(String key,
                                         String value)

Add footer to message.

Parameters:

key - Key of the footer entry

value - Value of the footer entry

Returns:

Current builder instance

Since:

1.1.0

build

public ConventionalCommit build()

Build the conventional commit with the given values.

Returns:

Conventional commit

Since:

1.1.0