semver/io.github.z4kn4fein.semver/Version

Version

class Version : Comparable<Version>

This class describes a semantic version and related operations.

Constructors

fun Version(major: Int, minor: Int, patch: Int, preRelease: String? = null, buildMetadata: String? = null)

Constructs a semantic version from the given arguments following the pattern: <major>.<minor>.<patch>-<preRelease>+<buildMetadata>

Types

object Companion

Companion object of Version.

Functions

open operator override fun compareTo(other: Version): Int

operator fun component1(): Int

Component function that returns the MAJOR number of the version upon destructuring.

operator fun component2(): Int

Component function that returns the MINOR number of the version upon destructuring.

operator fun component3(): Int

Component function that returns the PATCH number of the version upon destructuring.

operator fun component4(): String?

Component function that returns the PRE-RELEASE part of the version upon destructuring.

operator fun component5(): String?

Component function that returns the BUILD-METADATA part of the version upon destructuring.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String

Properties

val buildMetadata: String? = null

The BUILD-METADATA part of the version.

val isPreRelease: Boolean

Returns true when the version is a pre-release version.

The MAJOR number of the version.

The MINOR number of the version.

The PATCH number of the version.

val preRelease: String?

The PRE-RELEASE part of the version.

Extensions

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.

fun Version.nextMajor(): Version

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

fun Version.nextMinor(): Version

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

fun Version.nextPatch(): Version

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

fun Version.nextPreRelease(): Version

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

Sources