net.snowflake.common.core

Class ComponentInfo

java.lang.Object

net.snowflake.common.core.ComponentInfo

public class ComponentInfo
extends Object

Component information, like version, SVN rev, etc is available through this class.

It works by interrogating the class passed to the initialize() method. Current implementation retrieves the version information from the jar that the passed in class had been loaded from, if any.

Author:

ppovinec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentInfo.Version Version info - purely a data class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_FORMAT_PATTERN Supported version format pattern

Constructor Summary

Constructors

Constructor and Description
ComponentInfo()

Method Summary

Modifier and Type	Method and Description
static ComponentInfo.Version	getVersion() Get the version info part of the ComponentInfo.
static void	initialize() Initialize the ComponentInfo by retrieving all the necessary information from the available sources.
static void	initialize(Class<?> klass) Initialize the ComponentInfo by retrieving all the necessary information from the available sources.
static void	initialize(ComponentInfo.Version version) Initialize the ComponentInfo by explicitly passing it a ComponentInfo.Version.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_FORMAT_PATTERN

public static final String VERSION_FORMAT_PATTERN

Supported version format pattern

See Also:

Constant Field Values

Constructor Detail

ComponentInfo

public ComponentInfo()

Method Detail

getVersion

public static ComponentInfo.Version getVersion()

Get the version info part of the ComponentInfo.

Returns:

version info

Throws:

IllegalStateException - if the ComponentInfo has not been initialized

initialize

public static void initialize()
                       throws Exception

Initialize the ComponentInfo by retrieving all the necessary information from the available sources.

Throws:

Exception - if unable to complete the initialization

initialize

public static void initialize(Class<?> klass)
                       throws Exception

Initialize the ComponentInfo by retrieving all the necessary information from the available sources.

Parameters:

klass - that should be interrogated

Throws:

Exception - if unable to complete the initialization

initialize

public static void initialize(ComponentInfo.Version version)

Initialize the ComponentInfo by explicitly passing it a ComponentInfo.Version.

Parameters:

version - that should be stored