api/dev.teogor.winds.api.model/Version/VersionBuilder

VersionBuilder

class VersionBuilder

A builder class for creating Version objects.

This class provides a fluent and expressive way to configure the properties of a Version object. You can use method chaining to set the major, minor, and patch version numbers, as well as the release flag, version qualifier, and deprecated flag. Once you have configured the properties you want, you can call the build() method to create a new Version object.

Example usage:

val versionBuilder = VersionBuilder()
  .major(1)
  .minor(2)
  .patch(3)
  .alphaRelease(4)
  .build()

println(versionBuilder) // Output: 1.2.3-alpha04

Constructors

constructor()

Properties

The major version number.

The minor version number.

The patch version number.

Functions

fun alphaRelease(version: Int): Version.VersionBuilder

Sets the release flag to alpha and the version qualifier to the provided value.

fun betaRelease(version: Int): Version.VersionBuilder

Sets the release flag to beta and the version qualifier to the provided value.

fun build(): Version

Builds and returns a new Version object with the configured properties.

setIsDeprecated

fun setIsDeprecated(): Version.VersionBuilder

Marks the version as deprecated.

versionQualifier

fun versionQualifier(versionQualifier: Int): Version.VersionBuilder

Sets the version qualifier to the provided value.

versionQualifierPadding

fun versionQualifierPadding(versionQualifierPadding: Int): Version.VersionBuilder

Sets the padding for the version qualifier to the provided value.