Package io.github.bakedlibs.dough.versions

Class MinecraftVersion

java.lang.Object

io.github.bakedlibs.dough.versions.SemanticVersion

io.github.bakedlibs.dough.versions.MinecraftVersion

All Implemented Interfaces:

Version, Comparable<Version>

public class MinecraftVersion
extends SemanticVersion

This is an extension of SemanticVersion, specifically designed for Minecraft's versioning system.

Author:

TheBusyBiscuit

See Also:

• SemanticVersion

Constructor Summary

Constructors

Constructor	Description
MinecraftVersion(int major, int minor, int patch)	This method constructs a new MinecraftVersion with the given version components.

Method Summary

Modifier and Type	Method	Description
static MinecraftVersion	get()	This attempts to get the MinecraftVersion on which the current Server is running on.
String	getAsString()	This method returns this Version as a human-readable format.
static boolean	isMocked()	This checks if the current Server instance is a mock (MockBukkit) and whether we are in a Unit Test environment.
static boolean	isMocked(Server server)	This checks if the current Server instance is a mock (MockBukkit) and whether we are in a Unit Test environment.
static MinecraftVersion	of(Server server)	This attempts to get the MinecraftVersion on which the given Server is currently running on.

Methods inherited from class io.github.bakedlibs.dough.versions.SemanticVersion

equals, equalsIgnorePatch, equalsIgnorePatch, getMajorVersion, getMinorVersion, getPatchVersion, hashCode, isAtLeast, isAtLeast, isEqualTo, isNewerThan, isOlderThan, isPatch, isSimilar, parse, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.bakedlibs.dough.versions.Version

compareTo, isAtLeast

Constructor Details

MinecraftVersion

public MinecraftVersion(int major,
 int minor,
 int patch)

This method constructs a new MinecraftVersion with the given version components.

Parameters:

major - The "major" version (according to semver)

minor - The "minor" version (according to semver)

patch - The "patch" version (according to semver)

Method Details

of

@Nonnull
public static MinecraftVersion of(@Nonnull
 Server server)
                           throws UnknownServerVersionException

This attempts to get the MinecraftVersion on which the given Server is currently running on.

Parameters:

server - The Server instance

Returns:

The current MinecraftVersion

Throws:

UnknownServerVersionException - This exception is thrown when the Server version could not be identified

get

@Nonnull
public static MinecraftVersion get()
                            throws UnknownServerVersionException

This attempts to get the MinecraftVersion on which the current Server is running on.

Returns:

The current MinecraftVersion

Throws:

UnknownServerVersionException - This exception is thrown when the Server version could not be identified

isMocked

public static boolean isMocked(@Nonnull
 Server server)

This checks if the current Server instance is a mock (MockBukkit) and whether we are in a Unit Test environment.

Parameters:

server - The Server implementation to investigate

Returns:

Whether the current Server instance is a mock

isMocked

public static boolean isMocked()

This checks if the current Server instance is a mock (MockBukkit) and whether we are in a Unit Test environment.

Returns:

Whether the current Server instance is a mock

getAsString

@Nonnull
public String getAsString()

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

Specified by:

getAsString in interface Version

Overrides:

getAsString in class SemanticVersion

Returns:

A human-readable String representation of this Version