IHaveArgumentFiles Interface

Summary

Interface for all commands supporting multiple files as arguments.
Assembly
Cake.7zip.dll
Namespace
Cake.SevenZip.Arguments
Interfaces
Implementing Types
graph BT Type-.->Interface0["IHaveArgument"] click Interface0 "/api/Cake.SevenZip.Arguments/IHaveArgument" Type["IHaveArgumentFiles"] class Type type-node Implementing0["TestCommand"]-.->Type click Implementing0 "/api/Cake.SevenZip.Commands/TestCommand" Implementing1["HashCommand"]-.->Type click Implementing1 "/api/Cake.SevenZip.Commands/HashCommand" Implementing2["BaseAddLikeSyntaxCommand"]-.->Type click Implementing2 "/api/Cake.SevenZip.Commands/BaseAddLikeSyntaxCommand" Implementing3["DeleteCommand"]-.->Type click Implementing3 "/api/Cake.SevenZip.Commands/DeleteCommand" Implementing4["AddCommand"]-.->Type click Implementing4 "/api/Cake.SevenZip.Commands/AddCommand" Implementing5["UpdateCommand"]-.->Type click Implementing5 "/api/Cake.SevenZip.Commands/UpdateCommand"

Syntax

public interface IHaveArgumentFiles : IHaveArgument

Attributes

Type Description
NullableContextAttribute

Properties

Name Value Summary
Files FilePathCollection
Gets or sets the list of files this command operates on. These are single files. (I.e. to add to, or to remove from the archive).

For add and update, single files from the file-system will always be placed directly into the archive without any directory-structure.

Setting Files like this in add/update: 
Files = new[] {
  new FilePath("C:\\some\\place\\a.txt"),
  new FilePath("C:\\some\\other\\place\\b.txt"),
  new FilePath("C:\\a\\totally\\different\\place\\c.txt")
};
Will result in an archive: 
Archive.zip
- a.txt
- b.txt
- c.txt
without any directory structure.

Extension Methods

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