Package io.github.chrimle.semver

Enum Class Change

java.lang.Object

java.lang.Enum<Change>

io.github.chrimle.semver.Change

All Implemented Interfaces:

Serializable, Comparable<Change>, Constable

@API(status=STABLE,
     since="1.0.1")
public enum Change
extends Enum<Change>

The type of change in Semantic Versioning.

Since:

1.0.0

Author:

Chrimle

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAJOR	Definition "MAJOR version when you make incompatible API changes."
MINOR	Definition "MINOR version when you add functionality in a backward compatible manner."
PATCH	Definition "PATCH version when you make backward compatible bug fixes."

Method Summary

Modifier and Type	Method	Description
static Change	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Change[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MAJOR

@API(status=STABLE,
     since="1.2.0")
public static final Change MAJOR

Definition

"MAJOR version when you make incompatible API changes."

Semantic Versioning: Summary

Since:

1.0.0

MINOR

@API(status=STABLE,
     since="1.2.0")
public static final Change MINOR

Definition

"MINOR version when you add functionality in a backward compatible manner."

Semantic Versioning: Summary

Since:

1.0.0

PATCH

@API(status=STABLE,
     since="1.2.0")
public static final Change PATCH

Definition

"PATCH version when you make backward compatible bug fixes."

Semantic Versioning: Summary

Since:

1.0.0

Method Details

values

public static Change[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Change valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null