org.clapper.util.misc

Class VersionBase

java.lang.Object

org.clapper.util.misc.VersionBase

Direct Known Subclasses:

Version

public abstract class VersionBase
extends java.lang.Object

Base class for classes that want to access and display version information that's stored in a resource bundle generated by BuildInfo.makeBuildInfoBundle() as well as a static resource bundle containing non-build related strings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VersionBase() Creates a new instance of VersionBase

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationName() Get the application name.
protected abstract java.lang.String	getApplicationNameKey() Get the key for the name of the utility or application.
protected abstract java.lang.String	getBuildInfoBundleName() Get the class name of the build info resource bundle, which contains data about when the product was built, generated (presumably) during the build by BuildInfo.makeBuildInfoBundle().
java.lang.String	getCopyright() Get the copyright string.
protected abstract java.lang.String	getCopyrightKey() Get the key for the copyright string.
java.lang.String	getVersion() Get the version number.
protected abstract java.lang.String	getVersionBundleName() Get the class name of the version resource bundle, which contains values for the product version, copyright, etc.
java.lang.String	getVersionDisplay() Get the multiline version output.
protected abstract java.lang.String	getVersionKey() Get the key for the version string.

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionBase

protected VersionBase()

Creates a new instance of VersionBase

Method Detail

getVersion

public java.lang.String getVersion()

Get the version number.

Returns:

the version number

getCopyright

public java.lang.String getCopyright()

Get the copyright string.

Returns:

the copyright string.

getApplicationName

public java.lang.String getApplicationName()

Get the application name.

Returns:

the application name

getVersionDisplay

public java.lang.String getVersionDisplay()

Get the multiline version output. The returned string will have embedded newlines, but no trailing newline.

Returns:

the multiline version output.

getVersionBundleName

protected abstract java.lang.String getVersionBundleName()

Get the class name of the version resource bundle, which contains values for the product version, copyright, etc.

Returns:

the name of the version resource bundle

getBuildInfoBundleName

protected abstract java.lang.String getBuildInfoBundleName()

Get the class name of the build info resource bundle, which contains data about when the product was built, generated (presumably) during the build by BuildInfo.makeBuildInfoBundle().

Returns:

the name of the build info resource bundle

getVersionKey

protected abstract java.lang.String getVersionKey()

Get the key for the version string. This key is presumed to be in the version resource bundle.

Returns:

the version string key

getCopyrightKey

protected abstract java.lang.String getCopyrightKey()

Get the key for the copyright string. This key is presumed to be in the version resource bundle.

Returns:

the copyright string key

getApplicationNameKey

protected abstract java.lang.String getApplicationNameKey()

Get the key for the name of the utility or application.

Returns:

the key