Summary

A collection of DirectoryPath.

Namespace

Cake.Core.IO

Interfaces

IEnumerable<DirectoryPath>
IEnumerable

Base Types

object

graph BT Type-->Base0["object"] Type-.->Interface0["IEnumerable<DirectoryPath>"] Type-.->Interface1["IEnumerable"] Type["DirectoryPathCollection"] class Type type-node

Syntax

public sealed class DirectoryPathCollection : IEnumerable<DirectoryPath>, IEnumerable

Constructors

Name	Summary
DirectoryPathCollection()	Initializes a new instance of the `DirectoryPathCollection` class.
DirectoryPathCollection(IEnumerable<DirectoryPath>, PathComparer)	Initializes a new instance of the `DirectoryPathCollection` class.
DirectoryPathCollection(IEnumerable<DirectoryPath>)	Initializes a new instance of the `DirectoryPathCollection` class.
DirectoryPathCollection(PathComparer)	Initializes a new instance of the `DirectoryPathCollection` class.

Properties

Name	Value	Summary
Count	int	Gets the number of directories in the collection.

Methods

Name	Value	Summary
Add(DirectoryPath)	bool	Adds the specified path to the collection.
Add(IEnumerable<DirectoryPath>)	void	Adds the specified paths to the collection.
GetEnumerator()	IEnumerator<DirectoryPath>	Returns an enumerator that iterates through the collection.
Remove(DirectoryPath)	bool	Removes the specified path from the collection.
Remove(IEnumerable<DirectoryPath>)	void	Removes the specified paths from the collection.

Operators

Name	Value	Summary
operator -(DirectoryPathCollection, DirectoryPath)	DirectoryPathCollection
operator -(DirectoryPathCollection, IEnumerable<DirectoryPath>)	DirectoryPathCollection
operator +(DirectoryPathCollection, DirectoryPath)	DirectoryPathCollection
operator +(DirectoryPathCollection, IEnumerable<DirectoryPath>)	DirectoryPathCollection

Extension Methods

Name	Value	Summary
Dump<DirectoryPathCollection>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<DirectoryPathCollection>(DirectoryPathCollection[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DirectoryPathCollection>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<DirectoryPathCollection>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<DirectoryPathCollection>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<DirectoryPathCollection>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin