com.levigo.jadice.document
Class ProductInformation

java.lang.Object
  com.levigo.jadice.document.ProductInformation

public class ProductInformation
extends Object

This class provides information about the jadice document platform product. The product information comes in two types: "global", coarse-grained information provided by the static getter methods (e.g. getVersion()) and per-module (i.e. per-artifact) information provided by the getArtifacts()/getArtifact(String) methods.

Nested Class Summary

static class

ProductInformation.Artifact This class describes a single artifact.

Field Summary

static String	TEXT_DO_NOT_USE_IN_PRODUCTION
static String	TEXT_UNSUPPORTED_PREVIEW_VERSION

Constructor Summary

ProductInformation()

Method Summary

static ProductInformation.Artifact	getArtifact(String compositeID) Get the artifact with the given composite id of the form group-ID:artifact-ID.
static String	getArtifactID() Return the main maven artifact-ID for jadice document platform.
static Map<String,ProductInformation.Artifact>	getArtifacts() Return a map of artifacts contained in this installation.
static Date	getBuildTimestamp() Return the build timestamp for the main jadice document platform artifact.
static String	getGroupID() Return the main maven group-ID for jadice document platform.
static int	getMajorVersion() Return the major version number, i.e.
static int	getMinorVersion() Return the minor version number, i.e.
static int	getPatchLevel() Return the patch level, i.e.
static String	getProductId() Return the product-ID used for prefixing qualified log messages.
static int	getReleaseVersion() Return the release version number, i.e.
static String	getVersion() Return the full version string for the main jadice document platform artifact.
static int	getVersionPart(int i) Return the i'th version part of the version number of the jadice document platform.
static boolean	isRelease() Return whether this is a release version.
static boolean	isSnapshot() Return whether this is a snapshot version.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_DO_NOT_USE_IN_PRODUCTION

public static final String TEXT_DO_NOT_USE_IN_PRODUCTION

See Also:

Constant Field Values

TEXT_UNSUPPORTED_PREVIEW_VERSION

public static final String TEXT_UNSUPPORTED_PREVIEW_VERSION

See Also:

Constant Field Values

Constructor Detail

ProductInformation

public ProductInformation()

Method Detail

getArtifacts

public static Map<String,ProductInformation.Artifact> getArtifacts()

Return a map of artifacts contained in this installation.

Returns:

the map of ProductInformation.Artifacts indexed by composite id.

getProductId

public static String getProductId()

Return the product-ID used for prefixing qualified log messages.

Returns:

the product-ID PRODUCT_ID

getArtifactID

public static String getArtifactID()

Return the main maven artifact-ID for jadice document platform.

Returns:

the artifact-ID

getGroupID

public static String getGroupID()

Return the main maven group-ID for jadice document platform.

Returns:

the group-ID

getVersion

public static String getVersion()

Return the full version string for the main jadice document platform artifact.

Returns:

the version string

getVersionPart

public static int getVersionPart(int i)

Return the i'th version part of the version number of the jadice document platform.

Parameters:

i - the part to retrieve, i.e. part 0 = major version, part 1 = minor version etc.

Returns:

the version number part

See Also:

getMajorVersion(), getMinorVersion(), getReleaseVersion(), getPatchLevel()

isSnapshot

public static boolean isSnapshot()

Return whether this is a snapshot version.

Returns:

true for snapshot versions

isRelease

public static boolean isRelease()

Return whether this is a release version.

Returns:

true for release versions

getBuildTimestamp

public static Date getBuildTimestamp()

Return the build timestamp for the main jadice document platform artifact.

Returns:

the build timestamp.

getMajorVersion

public static int getMajorVersion()

Return the major version number, i.e. the first part of the version string.

Returns:

the major version number

getMinorVersion

public static int getMinorVersion()

Return the minor version number, i.e. the second part of the version string.

Returns:

the minor version number

getReleaseVersion

public static int getReleaseVersion()

Return the release version number, i.e. the third part of the version string.

Returns:

the release version number

getPatchLevel

public static int getPatchLevel()

Return the patch level, i.e. the fourth part of the version string.

Returns:

the patch level

getArtifact

public static ProductInformation.Artifact getArtifact(String compositeID)

Get the artifact with the given composite id of the form group-ID:artifact-ID.

Parameters:

compositeID - the composite id

Returns:

the ProductInformation.Artifact or null if it was not found.