Package io.github.bakedlibs.dough.versions

Interface Version

All Superinterfaces:

Comparable<Version>

All Known Implementing Classes:

MinecraftVersion, PrefixedVersion, SemanticVersion, SimpleNumericVersion

public interface Version
extends Comparable<Version>

A Version is a unique name or number that describes the condition of an object. Versions can be compared with each other and a Version is either equal to, newer than or older than another Version.

There are various different formats to describe a Version, the most popular format being SemanticVersion (e.g. 1.4.2).

This interface describes the base characteristics of what a Version is and means to compare them.

Author:

TheBusyBiscuit

See Also:

• Versioned

Method Summary

Modifier and Type	Method	Description
default int	compareTo(Version version)
String	getAsString()	This method returns this Version as a human-readable format.
default boolean	isAtLeast(Version version)	This method returns whether this Version is equal to or newer than the provided Version.
boolean	isEqualTo(Version version)	This method returns whether this Version is equal to the given Version.
boolean	isNewerThan(Version version)	This method returns whether this Version is newer than the provided Version.
boolean	isOlderThan(Version version)	This method returns whether this Version is older than the provided Version.
boolean	isSimilar(Version version)	This returns whether this Version is "similar" to the given Version.

Method Details

isNewerThan

boolean isNewerThan(@Nonnull
 Version version)

This method returns whether this Version is newer than the provided Version. This also implies that the provided Version is older than this Version, see isOlderThan(Version).

This method may throw an IncomparableVersionsException if the two versions cannot be compared with each other.

Parameters:

version - The Version to compare this to

Returns:

Whether this Version is newer than the provided one.

isEqualTo

boolean isEqualTo(@Nonnull
 Version version)

This method returns whether this Version is equal to the given Version.

This method may throw an IncomparableVersionsException if the two versions cannot be compared with each other.

Parameters:

version - The Version to compare this to

Returns:

Whether the given Version is equal to this Version.

isOlderThan

boolean isOlderThan(@Nonnull
 Version version)

This method returns whether this Version is older than the provided Version. This also implies that the provided Version is newer than this Version, see isNewerThan(Version).

This method may throw an IncomparableVersionsException if the two versions cannot be compared with each other.

Parameters:

version - The Version to compare this to

Returns:

Whether this Version is older than the provided one.

isAtLeast

default boolean isAtLeast(@Nonnull
 Version version)

This method returns whether this Version is equal to or newer than the provided Version.

This method may throw an IncomparableVersionsException if the two versions cannot be compared with each other.

Parameters:

version - The Version to compare this to

Returns:

This returns whether this is equal to or newer than the given Version

isSimilar

boolean isSimilar(@Nonnull
 Version version)

This returns whether this Version is "similar" to the given Version. Two Versions are considered "similar" when they can be compared to each other without causing an IncomparableVersionsException.

Parameters:

version - The Version to check

Returns:

Whether the two Versions can be compared.

getAsString

@Nonnull
String getAsString()

This method returns this Version as a human-readable format. Example: 1.4.2.

Returns:

A human-readable String representation of this Version

compareTo

default int compareTo(@Nullable
 Version version)

Specified by:

compareTo in interface Comparable<Version>