FileSet Class

Summary

Finds a set of FilePath based on input patterns.
Assembly
Cake.FileSet.dll
Namespace
Cake.FileSet
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["FileSet"] class Type type-node

Syntax

public class FileSet

Remarks

The Microsoft globbing library supports the following two wildcard characters; `*` and `**` (See https://docs.microsoft.com/en-us/aspnet/core/fundamentals/file-providers#globbing-patterns for more information). * - Matches anything at the current folder level, or any filename, or any file extension.Matches are terminated by / and . characters in the file path. ** - Matches anything across multiple directory levels.Can be used to recursively match many files within a directory hierarchy. Globbing pattern examples: directory/file.txt - Matches a specific file in a specific directory. directory/*.txt - Matches all files with .txt extension in a specific directory. directory/*/bower.json - Matches all bower.json files in directories exactly one level below the directory directory. directory/**/*.txt - Matches all files with .txt extension found anywhere under the directory directory.

Methods

Name Value Summary
Find(FileSetSettings) IEnumerable<FilePath>
Gets a fileset by FileSetSettings
static
Find(string, IEnumerable<string>, bool) IEnumerable<FilePath>
Gets a fileset by FileSetSettings
static
Find(string, IEnumerable<string>, IEnumerable<string>, bool) IEnumerable<FilePath>
Gets a fileset by FileSetSettings
static
Find(string, string, IEnumerable<string>, bool) IEnumerable<FilePath>
Gets a fileset by FileSetSettings
static

Extension Methods

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