TPG.Utils.SemanticVersionNumber Class Reference

Semantic version number, http://semver.org/. More...

Inheritance diagram for TPG.Utils.SemanticVersionNumber:

Public Member Functions
	SemanticVersionNumber (int major, int minor, int patch, string releaseState=null)
SemanticVersionNumber	GetNextMajorVersion (string releaseStateString=null)
	Get new version instance with next major version.
SemanticVersionNumber	GetNextMinorVersion (string releaseStateString=null)
	Get new version instance with next minor version.
SemanticVersionNumber	GetNextPatchVersion (string releaseStateString=null)
	Get new version instance with next patch version.
override int	GetHashCode ()
int	CompareTo (SemanticVersionNumber other)
bool	Equals (SemanticVersionNumber other)
override bool	Equals (object obj)
override string	ToString ()

Static Public Member Functions
static SemanticVersionNumber	Parse (string verString, SemanticVersionNumber defaultVersion=null)
	Parse string rep of version number.
static int	Compare (SemanticVersionNumber a, SemanticVersionNumber b)
	Compare version numbers "a" and "b".
static bool	operator!= (SemanticVersionNumber o1, SemanticVersionNumber o2)
static bool	operator== (SemanticVersionNumber o1, SemanticVersionNumber o2)

Properties
string	VersionString [get]
	Get string rep of version number.
string	ReleaseState [get]
	Release state string. "null" if no state/release.
int	Major [get]
	Major version, only increase for incompatible API changes.
int	Minor [get]
	Minor version, increase for backwards compatible added/changed functionality.
int	Patch [get]
	Patch version, increase for bugfixes not affectiong API/interface.

Detailed Description

Semantic version number, http://semver.org/.

Constructor & Destructor Documentation

SemanticVersionNumber()

TPG.Utils.SemanticVersionNumber.SemanticVersionNumber ( int  major, int  minor, int  patch, string  releaseState = null  )

inline

Parameters

major	Major version, incompatible API changes
minor	Minor version, backwards compatible added/changed functionality
patch	Backwards compatible bugfixes
releaseState	String identifying (pre) release state, ex "RC", "DRAFT". If not set, "release" type version is assumed (default)

Member Function Documentation

Compare()

static int TPG.Utils.SemanticVersionNumber.Compare ( SemanticVersionNumber  a, SemanticVersionNumber  b  )

inlinestatic

Compare version numbers "a" and "b".

Parameters

a	First version number
b	Second version number

Returns

-2 on error, -1 if a less than b, 0 if a equals b, 1 if a larger than b

GetNextMajorVersion()

SemanticVersionNumber TPG.Utils.SemanticVersionNumber.GetNextMajorVersion ( string  releaseStateString = null )

inline

Get new version instance with next major version.

Parameters

releaseStateString

Optional release state string

Returns

New version

GetNextMinorVersion()

SemanticVersionNumber TPG.Utils.SemanticVersionNumber.GetNextMinorVersion ( string  releaseStateString = null )

inline

Get new version instance with next minor version.

Parameters

releaseStateString

Optional release state string

Returns

New version

GetNextPatchVersion()

SemanticVersionNumber TPG.Utils.SemanticVersionNumber.GetNextPatchVersion ( string  releaseStateString = null )

inline

Get new version instance with next patch version.

Parameters

releaseStateString

Optional release state string

Returns

New version

Parse()

static SemanticVersionNumber TPG.Utils.SemanticVersionNumber.Parse ( string  verString, SemanticVersionNumber  defaultVersion = null  )

inlinestatic

Parse string rep of version number.

Parameters

verString

String on format MAJOR.MINOR.PATCH[-RELEASESTATE]

Parameters

defaultVersion

Return default if parsing fails

---

The documentation for this class was generated from the following file:

• Src/Libraries/TPG.Utils/SemanticVersionNumber.cs