rocks.cleancode.conventionalcommit

Class ConventionalCommit

java.lang.Object

rocks.cleancode.conventionalcommit.ConventionalCommit

public class ConventionalCommit
extends Object

Conventional commit message representation.

Based on specification Conventional Commits v1.0.0.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConventionalCommit.Builder Builder to ease conventional commit creation.

Constructor Summary

Constructors

Constructor and Description
ConventionalCommit(String type, String description) Simple constructor.
ConventionalCommit(String type, String scope, boolean exclamation, String description, String body, Map<String,String> footer) All arguments constructor.

Method Summary

Modifier and Type	Method and Description
Optional<String>	body() Message body.
boolean	breakingChange() Indicator of breaking change.
String	description() Message description.
boolean	exclamation() Message with exclamation mark.
Map<String,String>	footer() Key/value footer list.
Optional<String>	scope() Message scope.
String	toString() Generate conventional commit message.
String	type() Message type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConventionalCommit

public ConventionalCommit(String type,
                          String scope,
                          boolean exclamation,
                          String description,
                          String body,
                          Map<String,String> footer)

All arguments constructor.

Parameters:

type - Message type; must be one of the following values: fix, feat, build, chore, ci, docs, style, refactor, perf, or test

scope - Custom message scope; might be null

exclamation - true if exclamation mark appears in the message, false otherwise

description - Message description

body - Full message body, might be multiline

footer - Key/value list of additional data

Throws:

IllegalStateException - If type or description is null or empty

Since:

1.0.0

ConventionalCommit

public ConventionalCommit(String type,
                          String description)

Simple constructor.

Parameters:

type - Message type; must be one of the following values: fix, feat, build, chore, ci, docs, style, refactor, perf, or test

description - Message description

Throws:

IllegalStateException - If type or description is null or empty

Since:

1.1.0

Method Detail

type

public String type()

Message type.

Returns:

Message type

Since:

1.0.0

scope

public Optional<String> scope()

Message scope.

Returns:

Optional with message scope; empty if it does not exist

Since:

1.0.0

exclamation

public boolean exclamation()

Message with exclamation mark.

Returns:

true if exclamation mark exists in message, false otherwise

Since:

1.0.0

description

public String description()

Message description.

Returns:

Message description

Since:

1.0.0

body

public Optional<String> body()

Message body.

Returns:

Optional with message body; empty if it does not exist

Since:

1.0.0

footer

public Map<String,String> footer()

Key/value footer list.

Returns:

Map representing footer key/value

Since:

1.0.0

breakingChange

public boolean breakingChange()

Indicator of breaking change.

Returns:

true if breaking change, false otherwise

Since:

1.0.0

toString

public String toString()

Generate conventional commit message.

Overrides:

toString in class Object

Returns:

Conventional commit message

Since:

1.0.0