Package net.videki.semver.cc.release.common

Enum ConventionalCommitType

java.lang.Object

java.lang.Enum<ConventionalCommitType>

net.videki.semver.cc.release.common.ConventionalCommitType

All Implemented Interfaces:

Serializable, Comparable<ConventionalCommitType>

public enum ConventionalCommitType
extends Enum<ConventionalCommitType>
implements Comparable<ConventionalCommitType>

Conventional commits accepted commit types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BREAKING_CHANGE	A breaking change
BUILD	Build related changes
CHORE	Changes to the build process or auxiliary tools and libraries such as documentation generation
CI	CI related changes
DOCS	Documentation related changes
FEAT	New feature added
FIX	Issue fix
REFACTOR	Refactoring
STYLE	Styling changes - where applicable
TEST	Test related changes

Method Summary

Modifier and Type	Method	Description
SemanticVersionChange	getChangeType()	Returns the affected change type for the change (which version part to increment).
List<String>	getCommitTypes()	Returns the affecting commit types.
static ConventionalCommitType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConventionalCommitType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

BREAKING_CHANGE

public static final ConventionalCommitType BREAKING_CHANGE

A breaking change

BUILD

public static final ConventionalCommitType BUILD

Build related changes

CHORE

public static final ConventionalCommitType CHORE

Changes to the build process or auxiliary tools and libraries such as documentation generation

CI

public static final ConventionalCommitType CI

CI related changes

DOCS

public static final ConventionalCommitType DOCS

Documentation related changes

FIX

public static final ConventionalCommitType FIX

Issue fix

FEAT

public static final ConventionalCommitType FEAT

New feature added

REFACTOR

public static final ConventionalCommitType REFACTOR

Refactoring

STYLE

public static final ConventionalCommitType STYLE

Styling changes - where applicable

TEST

public static final ConventionalCommitType TEST

Test related changes

Method Detail

values

public static ConventionalCommitType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConventionalCommitType c : ConventionalCommitType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConventionalCommitType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getChangeType

public SemanticVersionChange getChangeType()

Returns the affected change type for the change (which version part to increment).

Returns:

the change type.

getCommitTypes

public List<String> getCommitTypes()

Returns the affecting commit types.

Returns:

the commit types.