org.apache.manifoldcf.core.interfaces

Class VersionContext

java.lang.Object

org.apache.manifoldcf.core.interfaces.VersionContext

public class VersionContext
extends java.lang.Object

An instance of this class represents a version string, in combination with the configuration parameters and specification that produced it. Some clients will use the version string (e.g. the database), while others may find it more convenient to use the parameters or the specification. However: (1) It is ALWAYS wrong to use data from configuration or specification that is NOT represented in some way in the version string, either by exact representation, or by some proxy value; (2) Configuration and Specification are guaranteed to be the identical ones which were used during creation of the version string; (3) Configuration and Specification are provided as CONVENIENCES; they are not to be considered primary data for these objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected ConfigParams	params
protected Specification	specification
protected java.lang.String	versionString

Constructor Summary

Constructors

Constructor and Description
VersionContext(java.lang.String versionString, ConfigParams params, Specification specification) Constructor.

Method Summary

Modifier and Type	Method and Description
ConfigParams	getParams() Retrieve the configuration parameters
Specification	getSpecification() Retrieve the specification
java.lang.String	getVersionString() Retrieve the version String

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

versionString

protected final java.lang.String versionString

params

protected final ConfigParams params

specification

protected final Specification specification

Constructor Detail

VersionContext

public VersionContext(java.lang.String versionString,
                      ConfigParams params,
                      Specification specification)

Constructor.

Method Detail

getVersionString

public java.lang.String getVersionString()

Retrieve the version String

getParams

public ConfigParams getParams()

Retrieve the configuration parameters

getSpecification

public Specification getSpecification()

Retrieve the specification