PathCollection Class

Summary

A collection of Path.
Namespace
Cake.Core.IO
Interfaces
  • IEnumerable<Path>
  • IEnumerable
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IEnumerable<Path>"] Type-.->Interface1["IEnumerable"] Type["PathCollection"] class Type type-node

Syntax

public sealed class PathCollection : IEnumerable<Path>, IEnumerable

Constructors

Name Summary
PathCollection() Initializes a new instance of the PathCollection class.
PathCollection(IEnumerable<Path>) Initializes a new instance of the PathCollection class.
PathCollection(IEnumerable<Path>, PathComparer) Initializes a new instance of the PathCollection class.
PathCollection(PathComparer) Initializes a new instance of the PathCollection class.

Properties

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

Methods

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

Operators

Name Value Summary
operator -(PathCollection, IEnumerable<Path>) PathCollection
operator -(PathCollection, Path) PathCollection
operator +(PathCollection, IEnumerable<Path>) PathCollection
operator +(PathCollection, Path) PathCollection

Extension Methods

Name Value Summary
Dump<PathCollection>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PathCollection>(PathCollection[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PathCollection>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PathCollection>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<PathCollection>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<PathCollection>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin