TPG.Utils.SemanticVersionSpecification Class Reference

Used to specify wanted versions. More...

Inheritance diagram for TPG.Utils.SemanticVersionSpecification:

Public Types
enum	ReleaseStateQuery { AnyReleaseState , Release , Draft }
	Release state specification. Relates to "REL-STATE" after numeric version info MAJ.MIN.PAT[-REL-STATE]. More...
enum	VersionQuery { AnyVersion , Exact , Newest }
	Determines how to select/match version numbers and. More...

Public Member Functions
	SemanticVersionSpecification ()
	Default constructor.
bool	Equals (SemanticVersionSpecification other)
	Equals override.
bool	IsMatch (SemanticVersionNumber candidateVersionNumber)
	Returns true if given version number matches specification.
List< SemanticVersionNumber >	Matches (IEnumerable< SemanticVersionNumber > candidateVersionNumbers)
	Returns all versions that matches specification.
override string	ToString ()

Static Public Member Functions
static SemanticVersionSpecification	CreateAnyNewest ()

Properties
SemanticVersionNumber	MinVersion [get, set]
	Minimum version number or required version if "Exact" version type is set.
string	MinVersionXml [get, set]
	Minimum version number or required version if "Exact" version type is set.
SemanticVersionNumber	MaxVersion [get, set]
	Max version number.
string	MaxVersionXml [get, set]
	Minimum version number or required version if "Exact" version type is set.
VersionQuery	VerQuery [get, set]
	How to match against versions.
ReleaseStateQuery	RelStateQuery [get, set]
	Determines if draft, release or both version types should be included.

Detailed Description

Used to specify wanted versions.

Member Enumeration Documentation

ReleaseStateQuery

enum TPG.Utils.SemanticVersionSpecification.ReleaseStateQuery

Release state specification. Relates to "REL-STATE" after numeric version info MAJ.MIN.PAT[-REL-STATE].

Enumerator
AnyReleaseState	Match for any release specification.
Release	Match if no release state specification, ex 1.0.0. No match for 1.0.0-DRAFT
Draft	Match if draft version, ex 1.0.0-DRAFT.

VersionQuery

enum TPG.Utils.SemanticVersionSpecification.VersionQuery

Determines how to select/match version numbers and.

Enumerator
AnyVersion	Matches any version number in range.
Exact	Only matches exact version number, "MinVersion".
Newest	If multiple matches in range, only match for highest version number. Note 2.0.0 > 1.99.99.

Member Function Documentation

Equals()

bool TPG.Utils.SemanticVersionSpecification.Equals ( SemanticVersionSpecification  other )

inline

Equals override.

Parameters

other

Returns

true if equal

IsMatch()

bool TPG.Utils.SemanticVersionSpecification.IsMatch ( SemanticVersionNumber  candidateVersionNumber )

inline

Returns true if given version number matches specification.

Parameters

candidateVersionNumber

Returns

True if candidate version number matches specification

Matches()

List< SemanticVersionNumber > TPG.Utils.SemanticVersionSpecification.Matches ( IEnumerable< SemanticVersionNumber >  candidateVersionNumbers )

inline

Returns all versions that matches specification.

Parameters

candidateVersionNumbers

Returns

List of candidate versions matching the specification

---

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

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