C# Class McSherry.SemanticVersioning.Monotonic.MonotonicVersioner

Datei anzeigen Open project: McSherry/McSherry.SemanticVersioning Class Usage Examples

Public Methods

Method	Description
Clone ( ) : MonotonicVersioner	Returns a MonotonicVersioner with an identical chronology, but which can advance its versions separately.
MonotonicVersioner ( ) : System	Creates a new MonotonicVersioner instance. The Compatibility number sequence produced by an instance which was created using this constructor starts at one. If a zero-based sequence is required, use MonotonicVersioner(bool).
MonotonicVersioner ( IEnumerable chronology ) : System	Creates a new MonotonicVersioner with the specified version number history. chronology is not required to be in order.
MonotonicVersioner ( bool startAtOne ) : System	Creates a new MonotonicVersioner instance with the specified initial compatibility line. The Monotonic Versioning Manifesto 1.2 does not specify whether the Compatibility component of versions are to start at one or zero. It is assumed that either is valid as neither is specifically recommended nor prohibited. If the Compatibility components are to start at one, MonotonicVersioner() may be used.
MonotonicVersioner ( bool startAtOne, IEnumerable metadata ) : System	Creates a new MonotonicVersioner instance with the specified initial compatibility line and metadata. The Monotonic Versioning Manifesto 1.2 does not specify whether the Compatibility component of versions are to start at one or zero. It is assumed that either is valid as neither is specifically recommended nor prohibited.
Next ( MonotonicChange change ) : SemanticVersion	Returns the next version number when a specified change is made to the latest version.
Next ( MonotonicChange change, IEnumerable metadata ) : SemanticVersion	Returns the next version number when a specified change is made to the latest version.
Next ( int line, MonotonicChange change ) : SemanticVersion	Returns the next version number when a specified change is made to a given line of compatibility.
Next ( int line, MonotonicChange change, IEnumerable metadata ) : SemanticVersion	Returns the next version number when a specified change is made to a given line of compatibility with the specified metadata.

Private Methods

Method	Description
_add ( SemanticVersion sv ) : SemanticVersion
_createReadOnlies ( ) : void
_isOrderedCtgsIntSeq ( IEnumerable seq ) : bool
_verifyMetadataColl ( IEnumerable metadata ) : void

Method Details

Clone() public method

Returns a MonotonicVersioner with an identical chronology, but which can advance its versions separately.

public Clone ( ) : MonotonicVersioner
return	MonotonicVersioner

MonotonicVersioner() public method

Creates a new MonotonicVersioner instance.

The Compatibility number sequence produced by an instance which was created using this constructor starts at one. If a zero-based sequence is required, use MonotonicVersioner(bool).

public MonotonicVersioner ( ) : System
return	System

MonotonicVersioner() public method

Creates a new MonotonicVersioner with the specified version number history.

chronology is not required to be in order.

/// or an item thereof is null. /// /// contains a version which is /// not a valid monotonic version. /// /// /// provides an incomplete /// version history. The chronology may: /// /// /// /// /// Not provide a contiguous sequence of /// numbers; /// /// /// /// /// Not provide a contiguous sequence of /// numbers; /// /// /// /// /// Not contain a starting at either /// zero or one; or /// /// /// /// /// Be empty. /// /// /// ///

public MonotonicVersioner ( IEnumerable chronology ) : System
chronology	IEnumerable	/// A collection of version numbers providing the version /// history to use for this instance. ///
return	System

MonotonicVersioner() public method

Creates a new MonotonicVersioner instance with the specified initial compatibility line.

The Monotonic Versioning Manifesto 1.2 does not specify whether the Compatibility component of versions are to start at one or zero. It is assumed that either is valid as neither is specifically recommended nor prohibited.

If the Compatibility components are to start at one, MonotonicVersioner() may be used.

public MonotonicVersioner ( bool startAtOne ) : System
startAtOne	bool	/// If true, the produced number /// sequence starts at one. If false, zero. ///
return	System

MonotonicVersioner() public method

Creates a new MonotonicVersioner instance with the specified initial compatibility line and metadata.

/// or an item thereof is null. /// /// One or more of the items in is not /// a valid metadata item. ///

public MonotonicVersioner ( bool startAtOne, IEnumerable metadata ) : System
startAtOne	bool	/// If true, the produced number /// sequence starts at one. If false, zero. ///
metadata	IEnumerable	/// Any metadata items to be included as part of the /// initial version number. ///
return	System

Next() public method

Returns the next version number when a specified change is made to the latest version.

/// /// is not a recognised type of change. /// ///

public Next ( MonotonicChange change ) : SemanticVersion
change	MonotonicChange	/// The type of change being made to the latest version. ///
return	SemanticVersion

Next() public method

Returns the next version number when a specified change is made to the latest version.

/// /// is not a recognised type of change. /// /// /// or an item therein is null. /// /// One or more items within is not a /// valid metadata string. ///

public Next ( MonotonicChange change, IEnumerable metadata ) : SemanticVersion
change	MonotonicChange	/// The type of change being made to the latest version. ///
metadata	IEnumerable	/// The metadata to be included with the new version. ///
return	SemanticVersion

Next() public method

Returns the next version number when a specified change is made to a given line of compatibility.

/// /// is negative. /// /// /// is not a recognised type of change. /// /// /// is not a current line of compatibility. ///

public Next ( int line, MonotonicChange change ) : SemanticVersion
line	int	/// The line of compatibility to which the change is being /// made. ///
change	MonotonicChange	/// The type of change being made to . ///
return	SemanticVersion

Next() public method

Returns the next version number when a specified change is made to a given line of compatibility with the specified metadata.

/// /// is negative. /// /// /// is not a recognised type of change. /// /// /// or an item therein is null. /// /// /// One or more items within is not a /// valid metadata string. /// /// /// is not a current line of compatibility. /// ///

public Next ( int line, MonotonicChange change, IEnumerable metadata ) : SemanticVersion
line	int	/// The line of compatibility to which the change is being /// made. ///
change	MonotonicChange	/// The type of change being made to . ///
metadata	IEnumerable	/// The metadata to be included with the new version. ///
return	SemanticVersion