C++ Micro Services: ModuleVersion Class Reference
ModuleVersion Class Reference

Version identifier for CppMicroServices modules. More...

Public Member Functions

 ModuleVersion (unsigned int majorVersion, unsigned int minorVersion, unsigned int microVersion)
 Creates a version identifier from the specified numerical components. More...
 
 ModuleVersion (unsigned int majorVersion, unsigned int minorVersion, unsigned int microVersion, const std::string &qualifier)
 Creates a version identifier from the specified components. More...
 
 ModuleVersion (const std::string &version)
 Created a version identifier from the specified string. More...
 
 ModuleVersion (const ModuleVersion &version)
 Create a version identifier from another. More...
 
bool IsUndefined () const
 Returns the undefined state of this version identifier. More...
 
unsigned int GetMajor () const
 Returns the majorVersion component of this version identifier. More...
 
unsigned int GetMinor () const
 Returns the minorVersion component of this version identifier. More...
 
unsigned int GetMicro () const
 Returns the microVersion component of this version identifier. More...
 
std::string GetQualifier () const
 Returns the qualifier component of this version identifier. More...
 
std::string ToString () const
 Returns the string representation of this version identifier. More...
 
bool operator== (const ModuleVersion &object) const
 Compares this ModuleVersion object to another object. More...
 
int Compare (const ModuleVersion &object) const
 Compares this ModuleVersion object to another object. More...
 

Static Public Member Functions

static ModuleVersion EmptyVersion ()
 The empty version "0.0.0". More...
 
static ModuleVersion UndefinedVersion ()
 Creates an undefined version identifier, representing either infinity or minus infinity. More...
 
static ModuleVersion ParseVersion (const std::string &version)
 Parses a version identifier from the specified string. More...
 

Detailed Description

Version identifier for CppMicroServices modules.

Version identifiers have four components.

  1. Major version. A non-negative integer.
  2. Minor version. A non-negative integer.
  3. Micro version. A non-negative integer.
  4. Qualifier. A text string. See ModuleVersion(const std::string&) for the format of the qualifier string.

ModuleVersion objects are immutable.

Constructor & Destructor Documentation

ModuleVersion::ModuleVersion ( unsigned int  majorVersion,
unsigned int  minorVersion,
unsigned int  microVersion 
)

Creates a version identifier from the specified numerical components.

The qualifier is set to the empty string.

Parameters
majorVersionMajor component of the version identifier.
minorVersionMinor component of the version identifier.
microVersionMicro component of the version identifier.
ModuleVersion::ModuleVersion ( unsigned int  majorVersion,
unsigned int  minorVersion,
unsigned int  microVersion,
const std::string &  qualifier 
)

Creates a version identifier from the specified components.

Parameters
majorVersionMajor component of the version identifier.
minorVersionMinor component of the version identifier.
microVersionMicro component of the version identifier.
qualifierQualifier component of the version identifier.
ModuleVersion::ModuleVersion ( const std::string &  version)

Created a version identifier from the specified string.

Here is the grammar for version strings.

version ::= majorVersion('.'minorVersion('.'microVersion('.'qualifier)?)?)?
majorVersion ::= digit+
minorVersion ::= digit+
microVersion ::= digit+
qualifier ::= (alpha|digit|'_'|'-')+
digit ::= [0..9]
alpha ::= [a..zA..Z]

There must be no whitespace in version.

Parameters
versionstring representation of the version identifier.
ModuleVersion::ModuleVersion ( const ModuleVersion version)

Create a version identifier from another.

Parameters
versionAnother version identifier

Member Function Documentation

int ModuleVersion::Compare ( const ModuleVersion object) const

Compares this ModuleVersion object to another object.

A version is considered to be less than another version if its majorVersion component is less than the other version's majorVersion component, or the majorVersion components are equal and its minorVersion component is less than the other version's minorVersion component, or the majorVersion and minorVersion components are equal and its microVersion component is less than the other version's microVersion component, or the majorVersion, minorVersion and microVersion components are equal and it's qualifier component is less than the other version's qualifier component (using std::string::operator<()).

A version is considered to be equal to another version if the majorVersion, minorVersion and microVersion components are equal and the qualifier component is equal.

Parameters
objectThe ModuleVersion object to be compared.
Returns
A negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified ModuleVersion object.
static ModuleVersion ModuleVersion::EmptyVersion ( )
static

The empty version "0.0.0".

unsigned int ModuleVersion::GetMajor ( ) const

Returns the majorVersion component of this version identifier.

Returns
The majorVersion component.
unsigned int ModuleVersion::GetMicro ( ) const

Returns the microVersion component of this version identifier.

Returns
The microVersion component.
unsigned int ModuleVersion::GetMinor ( ) const

Returns the minorVersion component of this version identifier.

Returns
The minorVersion component.
std::string ModuleVersion::GetQualifier ( ) const

Returns the qualifier component of this version identifier.

Returns
The qualifier component.
bool ModuleVersion::IsUndefined ( ) const

Returns the undefined state of this version identifier.

Returns
true if this version identifier is undefined, false otherwise.
bool ModuleVersion::operator== ( const ModuleVersion object) const

Compares this ModuleVersion object to another object.

A version is considered to be equal to another version if the majorVersion, minorVersion and microVersion components are equal and the qualifier component is equal.

Parameters
objectThe ModuleVersion object to be compared.
Returns
true if object is a ModuleVersion and is equal to this object; false otherwise.
static ModuleVersion ModuleVersion::ParseVersion ( const std::string &  version)
static

Parses a version identifier from the specified string.

See ModuleVersion(const std::string&) for the format of the version string.

Parameters
versionstring representation of the version identifier. Leading and trailing whitespace will be ignored.
Returns
A ModuleVersion object representing the version identifier. If version is the empty string then EmptyVersion will be returned.
std::string ModuleVersion::ToString ( ) const

Returns the string representation of this version identifier.

The format of the version string will be majorVersion.minorVersion.microVersion if qualifier is the empty string or majorVersion.minorVersion.microVersion.qualifier otherwise.

Returns
The string representation of this version identifier.
static ModuleVersion ModuleVersion::UndefinedVersion ( )
static

Creates an undefined version identifier, representing either infinity or minus infinity.