broadwick

Class BroadwickVersion

java.lang.Object

broadwick.BroadwickVersion

public final class BroadwickVersion
extends Object

This is a simple class to obtain the version number of the project from the manifest file of the packaged jar. To locate the version and build information of the framework, we locate the jar in which this object resides and interrogate the Manifest.MF file of that jar for the build info. This approach depends very much on how the jar file is used, for example, if the project using the jar in which this framework is delivered uses one-jar (and the maven plug-in top use this) then the framework jar is contained neatly with the other dependent jars. Using the maven assembly plug-in though expands the dependent jar files (and overwrites the manifest files and any other files with duplicate names it finds) so that at best the manifest file that is found will be the one of the project using the framework and it is that build info that will be displayed and NOT the frameworks.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BUILD_STRING_FORMAT
private static String	BUILD_TIMESTAMP
private static String	IMPL_BUILD
private static String	IMPL_VERSION
private static BroadwickVersion	version

Constructor Summary

Constructors

Modifier	Constructor and Description
private	BroadwickVersion() Private constructor to provide a singleton instance.

Method Summary

Modifier and Type	Method and Description
static String	getImplementationTimeStamp() Get the build time in the Manifest.MF of the jar.
private static String	getImplementationTimeStamp(Manifest manifest) Get the build timestamp from the supplied Manifest.mf file.
static String	getImplementationVersion() Get the implementation number defined in the Manifest.MF of the jar.
private static String	getImplementationVersion(Manifest manifest) Get the build version number from the supplied Manifest.mf file..
private static Manifest	getManifest() Get the object corresponding to the Manifest.mf file.
static String	getVersionAndTimeStamp() Get the build version number and timestamp.

Methods inherited from class java.lang.Object

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

Field Detail

version

private static BroadwickVersion version

BUILD_STRING_FORMAT

private static final String BUILD_STRING_FORMAT

See Also:

Constant Field Values

IMPL_VERSION

private static final String IMPL_VERSION

See Also:

Constant Field Values

IMPL_BUILD

private static final String IMPL_BUILD

See Also:

Constant Field Values

BUILD_TIMESTAMP

private static final String BUILD_TIMESTAMP

See Also:

Constant Field Values

Constructor Detail

BroadwickVersion

private BroadwickVersion()

Private constructor to provide a singleton instance.

Method Detail

getImplementationVersion

public static String getImplementationVersion()

Get the implementation number defined in the Manifest.MF of the jar. The build process get the label/tag of the most recent commit to the SCM and adds it as the implementation number to the jars manifest.

Returns:

the project version number that is obtained from the SCM.

getImplementationTimeStamp

public static String getImplementationTimeStamp()

Get the build time in the Manifest.MF of the jar. The build process adds the time of the build to the jars manifest.

Returns:

the project build timestamp that is obtained from the SCM.

getManifest

private static Manifest getManifest()

Get the object corresponding to the Manifest.mf file.

Returns:

the object for the Manifest file.

getImplementationTimeStamp

private static String getImplementationTimeStamp(Manifest manifest)

Get the build timestamp from the supplied Manifest.mf file.

Parameters:

manifest - the manifest file containing the timestamp info.

Returns:

a string containing the project build timestamp.

getImplementationVersion

private static String getImplementationVersion(Manifest manifest)

Get the build version number from the supplied Manifest.mf file..

Parameters:

manifest - the manifest file containing the version info.

Returns:

a string containing the project version.

getVersionAndTimeStamp

public static String getVersionAndTimeStamp()

Get the build version number and timestamp. This gets the following attributes in the manifest file Implementation-Version Implementation-Build Build-timestamp If the manifest file is NOT the one for the framework (i.e. a model that utilises the framework) then it will report the versions of both.

Returns:

a string containing the version and timestamp.