io.github.nucleuspowered.nucleus.api.service

Class NucleusAPIMetaService

java.lang.Object

io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService

public final class NucleusAPIMetaService
extends Object

This service provides information about the API itself.

This service is available from PRE INIT - Late order.

Constructor Summary

Constructors

Constructor and Description
NucleusAPIMetaService(String version, String semver, boolean isRelease)

Method Summary

Modifier and Type	Method and Description
boolean	isRelease() Returns whether this is a release version.
int	major() The major component of the version number.
int	minor() The minor component of the version number.
int	patch() The patch component of the version number.
String	semanticVersion() The version of the Nucleus API this is, or will be, if this is a snapshot.
String	version() The version of the Nucleus API this is.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NucleusAPIMetaService

public NucleusAPIMetaService(String version,
                             String semver,
                             boolean isRelease)

Method Detail

version

public String version()

The version of the Nucleus API this is.

Returns:

The version. This might include specifiers like "-SNAPSHOT" or "-PR1".

semanticVersion

public String semanticVersion()

The version of the Nucleus API this is, or will be, if this is a snapshot.

Returns:

The semantic version.

major

public int major()

The major component of the version number. Note that there may be breakages between major versions.

Returns:

The major version.

minor

public int minor()

The minor component of the version number. Breakages should not occur between minor versions, but there may be new features included.

Returns:

The minor version.

patch

public int patch()

The patch component of the version number. These are bug fixes only.

Returns:

The patch version.

isRelease

public boolean isRelease()

Returns whether this is a release version.

Returns:

true if so.