Summary
Represents a file path.
graph BT
Type-->Base0["Path"]
click Base0 "/api/Cake.Core.IO/Path"
Base0-->Base1["object"]
Type-.->Interface0["IEquatable<FilePath>"]
Type-.->Interface1["IComparer<FilePath>"]
Type-.->Interface2["IPath<FilePath>"]
Type["FilePath"]
class Type type-node
Syntax
[TypeConverter(typeof(FilePathConverter))]
public sealed class FilePath : Path, IEquatable<FilePath>, IComparer<FilePath>, IPath<FilePath>
Attributes
Type | Description |
---|---|
TypeConverter |
Constructors
Name | Summary |
---|---|
FilePath |
Initializes a new instance of the FilePath class.
|
Properties
Name | Value | Summary |
---|---|---|
FullPath | string |
Gets the full path.
Inherited from Path
|
HasExtension | bool |
Gets a value indicating whether this path has a file extension.
|
IsRelative | bool |
Gets a value indicating whether or not this path is relative.
Inherited from Path
|
IsUNC | bool |
Gets a value indicating whether or not this path is an UNC path.
Inherited from Path
|
Segments | string[] |
Gets the segments making up the path.
Inherited from Path
|
Separator | char |
Gets the separator this path was normalized with.
Inherited from Path
|
Methods
Name | Value | Summary |
---|---|---|
AppendExtension |
FilePath |
Appends a file extension to the path.
|
ChangeExtension |
FilePath |
Changes the file extension of the path.
|
Collapse |
FilePath |
Collapses a
FilePath containing ellipses.
|
Compare |
int |
Compares two FilePath and returns an indication of their relative sort order.
|
Equals |
bool |
Determines wheter two
FilePath instances are equal.
|
Equals |
bool |
Determines wheter two
FilePath instances are equal.
|
FromString |
FilePath |
static
|
GetDirectory |
DirectoryPath |
Gets the directory part of the path.
|
GetExtension |
string |
Gets the file extension.
|
GetFilename |
FilePath |
Gets the filename.
|
Get |
FilePath |
Gets the filename without its extension.
|
GetHashCode |
int |
Returns the hash code for the
FilePath .
|
GetRelativePath |
DirectoryPath |
Get the relative path to another directory.
|
GetRelativePath |
FilePath |
Get the relative path to another file.
|
MakeAbsolute |
FilePath |
Makes the path absolute (if relative) using the specified directory path.
|
MakeAbsolute |
FilePath |
Makes the path absolute (if relative) using the current working directory.
|
ToString |
string |
Returns a
string that represents this path.
Inherited from Path
|
Operators
Name | Value | Summary |
---|---|---|
implicit operator |
FilePath | |
operator != |
bool | |
operator == |
bool |
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
Expand |
FilePath |
Expands all environment variables in the provided
FilePath .
From PathExtensions
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|