PathComparer Class

Summary

Compares Path instances.
Namespace
Cake.Core.IO
Interfaces
  • IEqualityComparer<Path>
  • IComparer<Path>
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IEqualityComparer<Path>"] Type-.->Interface1["IComparer<Path>"] Type["PathComparer"] class Type type-node

Syntax

public sealed class PathComparer : IEqualityComparer<Path>, IComparer<Path>

Constructors

Name Summary
PathComparer(bool) Initializes a new instance of the PathComparer class.
PathComparer(ICakeEnvironment) Initializes a new instance of the PathComparer class.

Fields

Name Constant Value Summary
Default
The default path comparer.
static

Properties

Name Value Summary
IsCaseSensitive bool
Gets a value indicating whether comparison is case sensitive.

Methods

Name Value Summary
Compare(Path, Path) int
Compares two Paths and returns an indication of their relative sort order.
Equals(Path, Path) bool
Determines whether the specified Path instances are equal.
GetHashCode(Path) int
Returns a hash code for the specified Path.

Extension Methods

Name Value Summary
Dump<PathComparer>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PathComparer>(PathComparer[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PathComparer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PathComparer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<PathComparer>(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
ThrowIfNull<PathComparer>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin