Package io.github.bakedlibs.dough.versions

Class PrefixedVersion

java.lang.Object

io.github.bakedlibs.dough.versions.PrefixedVersion

All Implemented Interfaces:

Version, Comparable<Version>

public class PrefixedVersion
extends Object

This Version implementation consists of two components. A prefix, e.g. "DEV #" or "pre-" and a numeric version component. Only PrefixedVersions with the same prefix can be compared.

Author:

TheBusyBiscuit

Constructor Summary

Constructors

Constructor	Description
PrefixedVersion(String prefix, int version)	This constructs a new PrefixedVersion with the given prefix and version number.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAsString()	This method returns this Version as a human-readable format.
final String	getPrefix()	This returns the prefix for this PrefixedVersion.
final int	getVersionNumber()	This method returns the version number which this numeric Version represents.
int	hashCode()
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.
String	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

PrefixedVersion

public PrefixedVersion(@Nonnull
 String prefix,
 int version)

This constructs a new PrefixedVersion with the given prefix and version number. The version number cannot be negative.

Parameters:

prefix - The prefix

version - The version number

Method Details

isSimilar

public 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.

Specified by:

isSimilar in interface Version

Parameters:

version - The Version to check

Returns:

Whether the two Versions can be compared.

getAsString

@Nonnull
public 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

getPrefix

@Nonnull
public final String getPrefix()

This returns the prefix for this PrefixedVersion.

Returns:

The prefix

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getVersionNumber

public final int getVersionNumber()

This method returns the version number which this numeric Version represents.

Returns:

The version number

isNewerThan

public 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 Version.isOlderThan(Version).

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

Specified by:

isNewerThan in interface Version

Parameters:

version - The Version to compare this to

Returns:

Whether this Version is newer than the provided one.

isEqualTo

public 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.

Specified by:

isEqualTo in interface Version

Parameters:

version - The Version to compare this to

Returns:

Whether the given Version is equal to this Version.

isOlderThan

public 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 Version.isNewerThan(Version).

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

Specified by:

isOlderThan in interface Version

Parameters:

version - The Version to compare this to

Returns:

Whether this Version is older than the provided one.