org.jcoderz.commons
Class Version

java.lang.Object
  org.jcoderz.commons.Version

public final class Version
extends Object

This class holds version information at compile time. Compiled at 2011.04.21 15:46 GMT on ${env.HOSTNAME} by fawkez.

Author:

generated TODO: provide getter and constants for remaining properties.

Field Summary

static String	COMPILE_DATE Name of the property holding the compile date (w/o time).
static String	COMPILE_TIME Name of the property holding the compile time (w/o date).
static String	COPYRIGHT_YEAR Name of the property holding the project's copyright year.
static String	PROJECT_NAME Name of the property holding the project name.
static String	PROJECT_NAME_LOWERCASE Name of the property holding the project name (lowercase).
static String	PROJECT_PACKAGE Name of the property holding the project base Java package.
static String	RELEASE_VERSION Release version number from VERSION file.

Constructor Summary

Version()

Method Summary

static String	getCompileDateString() Returns the compile date (w/o time) as String.
static String	getCompileTimeString() Returns the compile time (w/o date) as String.
static String	getCopyrightYear() Returns the project's copyright year as String.
static String	getDescription()
static String	getProjectName() Returns the project name as String.
static String	getProjectNameLowerCase() Returns the project name in lowercase as String.
static Map	getProperties() Returns a unmodifiable Map <String, String> of all compile time properties.
static String	getProperty(String key) Returns the value of the named property.
static String	getReleaseVersion() Returns the release version number as String.
static void	main(String[] args) Dump the build version to System.out

Methods inherited from class java.lang.Object

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

Field Detail

RELEASE_VERSION

public static final String RELEASE_VERSION

Release version number from VERSION file.

See Also:

Constant Field Values

PROJECT_NAME

public static final String PROJECT_NAME

Name of the property holding the project name.

See Also:

Constant Field Values

PROJECT_NAME_LOWERCASE

public static final String PROJECT_NAME_LOWERCASE

Name of the property holding the project name (lowercase).

See Also:

Constant Field Values

PROJECT_PACKAGE

public static final String PROJECT_PACKAGE

Name of the property holding the project base Java package.

See Also:

Constant Field Values

COPYRIGHT_YEAR

public static final String COPYRIGHT_YEAR

Name of the property holding the project's copyright year.

See Also:

Constant Field Values

COMPILE_DATE

public static final String COMPILE_DATE

Name of the property holding the compile date (w/o time).

See Also:

Constant Field Values

COMPILE_TIME

public static final String COMPILE_TIME

Name of the property holding the compile time (w/o date).

See Also:

Constant Field Values

Constructor Detail

Version

public Version()

Method Detail

getProperties

public static Map getProperties()

Returns a unmodifiable Map <String, String> of all compile time properties.

Returns:

a unmodifiable Map <String, String> of all compile time properties.

getReleaseVersion

public static String getReleaseVersion()

Returns the release version number as String.

Returns:

the release version number as String.

getProjectName

public static String getProjectName()

Returns the project name as String.

Returns:

the project name as String.

getProjectNameLowerCase

public static String getProjectNameLowerCase()

Returns the project name in lowercase as String.

Returns:

the project name in lowercase as String.

getCopyrightYear

public static String getCopyrightYear()

Returns the project's copyright year as String.

Returns:

the project's copyright year as String.

getCompileDateString

public static String getCompileDateString()

Returns the compile date (w/o time) as String.

Returns:

the compile date (w/o time) as String.

getCompileTimeString

public static String getCompileTimeString()

Returns the compile time (w/o date) as String.

Returns:

the compile time (w/o date) as String.

getProperty

public static String getProperty(String key)

Returns the value of the named property.

Parameters:

key - the property name.

Returns:

the value of the named property or null if the given property is not available.

getDescription

public static String getDescription()

main

public static void main(String[] args)

Dump the build version to System.out