Semver

class Semver @JvmOverloads() constructor(originalValue: String, type: Semver.SemverType) : Comparable<Semver>

Semver is a tool that provides useful methods to manipulate versions that follow the "semantic versioning" specification (see http://semver.org)

Constructors

Semver

@JvmOverloads()

fun Semver(originalValue: String, type: Semver.SemverType = SemverType.STRICT)

Types

Companion

object Companion

SemverType

enum SemverType : Enum<Semver.SemverType>

The different types of supported version systems.

VersionDiff

enum VersionDiff : Enum<Semver.VersionDiff>

The types of diffs between two versions.

Functions

compareTo

open operator override fun compareTo(version: Semver): Int

diff

fun diff(version: Semver): Semver.VersionDiff

Returns the greatest difference between 2 versions.

fun diff(version: String): Semver.VersionDiff

equals

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

hashCode

open override fun hashCode(): Int

isEqualTo

fun isEqualTo(version: Semver): Boolean

Checks if the version equals another version

fun isEqualTo(version: String): Boolean

isEquivalentTo

fun isEquivalentTo(version: Semver): Boolean

Checks if the version equals another version, without taking the build into account.

fun isEquivalentTo(version: String): Boolean

isGreaterThan

fun isGreaterThan(version: Semver): Boolean

Checks if the version is greater than another version

fun isGreaterThan(version: String): Boolean

isGreaterThanOrEqualTo

fun isGreaterThanOrEqualTo(version: Semver): Boolean

Checks if the version is greater than or equal to another version

fun isGreaterThanOrEqualTo(version: String): Boolean

isLowerThan

fun isLowerThan(version: Semver): Boolean

Checks if the version is lower than another version

fun isLowerThan(version: String): Boolean

isLowerThanOrEqualTo

fun isLowerThanOrEqualTo(version: Semver): Boolean

Checks if the version is lower than or equal to another version

fun isLowerThanOrEqualTo(version: String): Boolean

nextMajor

fun nextMajor(): Semver

nextMinor

fun nextMinor(): Semver

nextPatch

fun nextPatch(): Semver

satisfies

fun satisfies(requirement: Requirement): Boolean

Check if the version satisfies a requirement

fun satisfies(requirement: String): Boolean

Check if the version satisfies a requirement

toStrict

fun toStrict(): Semver

toString

open override fun toString(): String

withBuild

fun withBuild(build: String?): Semver

withClearedBuild

fun withClearedBuild(): Semver

withClearedSuffix

fun withClearedSuffix(): Semver

withClearedSuffixAndBuild

fun withClearedSuffixAndBuild(): Semver

withIncMajor

@JvmOverloads()

fun withIncMajor(increment: Int = 1): Semver

withIncMinor

@JvmOverloads()

fun withIncMinor(increment: Int = 1): Semver

withIncPatch

@JvmOverloads()

fun withIncPatch(increment: Int = 1): Semver

withSuffix

fun withSuffix(suffix: String): Semver

Properties

build

val build: String?

Returns the build of the version.

isStable

val isStable: Boolean

Determines if the current version is stable or not.

major

var major: Int? = null

Returns the major part of the version.

minor

var minor: Int? = null

Returns the minor part of the version.

originalValue

val originalValue: String

patch

var patch: Int? = null

Returns the patch part of the version.

suffixTokens

val suffixTokens: Array<String?>?

Returns the suffix of the version.

type

val type: Semver.SemverType

value

val value: String

Get the original value as a string