Package de.espirit.firstspirit.agency

Interface ServerInformationAgent.VersionInfo

Enclosing interface:

ServerInformationAgent

public static interface ServerInformationAgent.VersionInfo

Interface representing the FirstSpirit version.

Since:

5.0.100

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ServerInformationAgent.VersionInfo.Mode	Indicates the mode which is currently active.
static enum	ServerInformationAgent.VersionInfo.Quality	Indicates the quality level of the related FirstSpirit version.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getBranch()	Returns the name of the branch of the belonging FirstSpirit version or null. Non-existent branch (null) indicates that the belonging FirstSpirit version is a stable version. e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return 'BETA'. If the FirstSpirit server runs with "5.0.50.68430" this method will return null.
int	getBuild()	Returns the build number of the belonging FirstSpirit version. e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '31'.
String	getFullVersionString()	Returns the full version string of the belonging FirstSpirit version. e.g.
int	getMajor()	Returns the major version of the belonging FirstSpirit version. e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '5'.
int	getMinor()	Returns the minor version of the belonging FirstSpirit version. e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '0'.
@NotNull ServerInformationAgent.VersionInfo.Mode	getMode()	Returns the mode which is currently active.
ServerInformationAgent.VersionInfo.Quality	getQuality()	Returns the quality state of the belonging FirstSpirit version.
@NotNull String	getReleaseName()	Returns the release name of the belonging FirstSpirit version. e.g.

Method Details

getMajor

int getMajor()

Returns the major version of the belonging FirstSpirit version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '5'.

Since:

5.0.100

getMinor

int getMinor()

Returns the minor version of the belonging FirstSpirit version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '0'.

Since:

5.0.100

getBuild

int getBuild()

Returns the build number of the belonging FirstSpirit version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '31'.

Since:

5.0.100

getBranch

@Nullable
@Nullable String getBranch()

Returns the name of the branch of the belonging FirstSpirit version or null.
Non-existent branch (null) indicates that the belonging FirstSpirit version is a stable version.
e.g.:

• If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return 'BETA'.
• If the FirstSpirit server runs with "5.0.50.68430" this method will return null.

Since:

5.0.100

getQuality

ServerInformationAgent.VersionInfo.Quality getQuality()

Returns the quality state of the belonging FirstSpirit version.

Returns:

the quality state of the version

Since:

5.0.111

See Also:

• ServerInformationAgent.VersionInfo.Quality

getMode

@NotNull
@NotNull ServerInformationAgent.VersionInfo.Mode getMode()

Returns the mode which is currently active.

Returns:

the mode of the version, never null.

Since:

5.2.706

getReleaseName

@NotNull
@NotNull String getReleaseName()

Returns the release name of the belonging FirstSpirit version.
e.g.

• "2022.5" (if getQuality() returns ServerInformationAgent.VersionInfo.Quality.STABLE)
• "2022.13 (EAP)" (if getQuality() returns ServerInformationAgent.VersionInfo.Quality.BETA)

Since:

5.2.180603

getFullVersionString

String getFullVersionString()

Returns the full version string of the belonging FirstSpirit version.
e.g.

• "5.0_BETA.31.51560" (if a branch exists)
• "5.0.31.51560" (if getBranch() delivers null)

Since:

5.0.100