Module qilletni.api

Package dev.qilletni.api.lib.qll

Class ComparableVersion

java.lang.Object

dev.qilletni.api.lib.qll.Version

dev.qilletni.api.lib.qll.ComparableVersion

All Implemented Interfaces:

Comparable<ComparableVersion>

public class ComparableVersion
extends Version
implements Comparable<ComparableVersion>

A Version that may be compared with others, fitting a range.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ComparableVersion.RangeSpecifier	Specifies how a version may be matched with other versions.

Constructor Summary

Constructors

Constructor	Description
ComparableVersion(int major, int minor, int patch, ComparableVersion.RangeSpecifier rangeSpecifier)	Creates a new ComparableVersion with the given major, minor, and patch versions, and a range specifier.
ComparableVersion(Version version, ComparableVersion.RangeSpecifier rangeSpecifier)	Creates a new ComparableVersion with the given Version and range specifier.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ComparableVersion other)	Comparable method to allow comparison between versions using java Comparables
static Optional<ComparableVersion>	parseComparableVersionString(String versionString)	Parses a ComparableVersion from a string, such as ^1.0.0.
boolean	permitsVersion(Version checkVersion)	Checks if the current ComparableVersion permits the given Version to be used in the current range.
String	toString()

Methods inherited from class dev.qilletni.api.lib.qll.Version

equals, getVersionString, hashCode, major, minor, parseVersionString, patch

Methods inherited from class java.lang.Object

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

Constructor Details

ComparableVersion

public ComparableVersion(int major,
 int minor,
 int patch,
 ComparableVersion.RangeSpecifier rangeSpecifier)

Creates a new ComparableVersion with the given major, minor, and patch versions, and a range specifier.

Parameters:

major - The major version

minor - The minor version

patch - The patch version

rangeSpecifier - The range specifier for the version

ComparableVersion

public ComparableVersion(Version version,
 ComparableVersion.RangeSpecifier rangeSpecifier)

Creates a new ComparableVersion with the given Version and range specifier.

Parameters:

version - The version to use, specifying the major, minor, and patch versions

rangeSpecifier - The range specifier for the version

Method Details

parseComparableVersionString

public static Optional<ComparableVersion> parseComparableVersionString(String versionString)

Parses a ComparableVersion from a string, such as ^1.0.0. If the version doesn't contain a range specifier, then ComparableVersion.RangeSpecifier.EXACT is set.

Parameters:

versionString - The version string to parse

Returns:

The created ComparableVersion, if the string was valid

permitsVersion

public boolean permitsVersion(Version checkVersion)

Checks if the current ComparableVersion permits the given Version to be used in the current range.

Parameters:

checkVersion - The version to compare

Returns:

If the version fits the bounds of the current ComparableVersion.RangeSpecifier

compareTo

public int compareTo(ComparableVersion other)

Comparable method to allow comparison between versions using java Comparables

Specified by:

compareTo in interface Comparable<ComparableVersion>

Parameters:

other - the ComparableVersion to be compared.

Returns:

the compare value between this version and the other ComparableVersion

toString

public String toString()

Overrides:

toString in class Version