Summary

A collection of FilePath.

Namespace

Cake.Core.IO

Interfaces

IEnumerable<FilePath>
IEnumerable

Base Types

object

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

Syntax

public sealed class FilePathCollection : IEnumerable<FilePath>, IEnumerable

Constructors

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

Properties

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

Methods

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

Operators

Name	Value	Summary
operator -(FilePathCollection, FilePath)	FilePathCollection
operator -(FilePathCollection, IEnumerable<FilePath>)	FilePathCollection
operator +(FilePathCollection, FilePath)	FilePathCollection
operator +(FilePathCollection, IEnumerable<FilePath>)	FilePathCollection

Extension Methods

Name	Value	Summary
Dump<FilePathCollection>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<FilePathCollection>(FilePathCollection[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<FilePathCollection>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<FilePathCollection>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<FilePathCollection>(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<FilePathCollection>(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