Package io.github.z4kn4fein.semver

Types

Version

class Version : Comparable<Version>

This class describes a semantic version and related operations.

VersionFormatException

class VersionFormatException(message: String) : Exception

Version throws this exception when the parsing fails due to an invalid format.

Functions

copy

fun Version.copy(major: Int = this.major, minor: Int = this.minor, patch: Int = this.patch, preRelease: String? = this.preRelease, buildMetadata: String? = this.buildMetadata): Version

Constructs a copy of the Version. The copied object's properties can be altered with the optional parameters.

nextMajor

fun Version.nextMajor(): Version

Increments the version by its MAJOR number. Returns a new version while the original remains unchanged.

nextMinor

fun Version.nextMinor(): Version

Increments the version by its MINOR number. Returns a new version while the original remains unchanged.

nextPatch

fun Version.nextPatch(): Version

Increments the version by its PATCH number. Returns a new version while the original remains unchanged.

nextPreRelease

fun Version.nextPreRelease(): Version

Increments the version by its PRE-RELEASE part. Returns a new version while the original remains unchanged.

toVersion

fun String.toVersion(): Version

Parses the string as a Version and returns the result or throws a VersionFormatException if the string is not a valid representation of a semantic version.

toVersionOrNull

fun String.toVersionOrNull(): Version?

Parses the string as a Version and returns the result or null if the string is not a valid representation of a semantic version.