sirius.kernel.info

Class Module

java.lang.Object

sirius.kernel.info.Module

public class Module
extends Object

Reports build-time information about a loaded SIRIUS module.

This is used to keep track of loaded modules in the system.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Module(String name, String version, String build, String date, String vcs)

Method Summary

Modifier and Type	Method and Description
protected static String	fix(String value, String replacement) As some module infos rely on a build environment (build server) their value will be the unreplaced version (${property}) in development systems.
String	getDetails() Returns a detailed description of the version of this module
String	getName() Returns the name of the module
String	getUniqueVersionString() Creates a string which is unqiue for each released version (based on its commit hash and build number.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

protected Module(String name,
                 String version,
                 String build,
                 String date,
                 String vcs)

Method Detail

getName

public String getName()

Returns the name of the module

Returns:

the name of the module

getDetails

public String getDetails()

Returns a detailed description of the version of this module

Returns:

a string containing the version, build number and VCS tag of this module

getUniqueVersionString

public String getUniqueVersionString()

Creates a string which is unqiue for each released version (based on its commit hash and build number.

For development and test systems which have neigther of both, a random string is created for each running instance.

Returns:

a unique version string per release or instance

fix

protected static String fix(String value,
                            String replacement)

As some module infos rely on a build environment (build server) their value will be the unreplaced version (${property}) in development systems.

Therefore we filter those values and return the given replacement.

Parameters:

value - the value to check

replacement - the replacement to use

Returns:

the given value or the replacement if the value is empty or a property key (starting with bracket - as the $ is swallowed by typesafe config)

toString

public String toString()

Overrides:

toString in class Object