Record Class SemanticVersion

java.lang.Object

java.lang.Record

io.github.joke.conventionalversion.calc.SemanticVersion

All Implemented Interfaces:

Serializable, Comparable<SemanticVersion>

public record SemanticVersion(int major, int minor, int patch)
extends Record
implements Comparable<SemanticVersion>, Serializable

A major.minor.patch version, without pre-release or build metadata.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SemanticVersion(int major, int minor, int patch)	Creates an instance of a SemanticVersion record class.

Method Summary

Modifier and Type	Method	Description
SemanticVersion	bumpMajor()
SemanticVersion	bumpMinor()
SemanticVersion	bumpPatch()
int	compareTo(SemanticVersion other)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isPreMajor()	Whether this version is below 1.0.0, which is the condition both pre-major policies are gated on.
int	major()	Returns the value of the major record component.
int	minor()	Returns the value of the minor record component.
static Optional<SemanticVersion>	parse(String text)	Parses 1.2.3, returning empty when the text is not exactly three numeric parts.
int	patch()	Returns the value of the patch record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SemanticVersion

public SemanticVersion(int major,
 int minor,
 int patch)

Creates an instance of a SemanticVersion record class.

Parameters:

major - the value for the major record component

minor - the value for the minor record component

patch - the value for the patch record component

Method Details

parse

public static Optional<SemanticVersion> parse(String text)

Parses 1.2.3, returning empty when the text is not exactly three numeric parts.

isPreMajor

public boolean isPreMajor()

Whether this version is below 1.0.0, which is the condition both pre-major policies are gated on.

bumpMajor

public SemanticVersion bumpMajor()

bumpMinor

public SemanticVersion bumpMinor()

bumpPatch

public SemanticVersion bumpPatch()

compareTo

public int compareTo(SemanticVersion other)

Specified by:

compareTo in interface Comparable<SemanticVersion>

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

major

public int major()

Returns the value of the major record component.

Returns:

the value of the major record component

minor

public int minor()

Returns the value of the minor record component.

Returns:

the value of the minor record component

patch

public int patch()

Returns the value of the patch record component.

Returns:

the value of the patch record component