This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.7zip.
Summary
BaseClass for add,update,delete.
- Assembly
- Cake
.7zip .dll - Namespace
- Cake
.SevenZip .Commands - Interfaces
- Base Types
-
- Object
- BaseCommand
- Derived Types
graph BT
Type-->Base0["BaseCommand"]
click Base0 "/api/Cake.SevenZip.Commands/BaseCommand"
Base0-->Base1["Object"]
Type-.->Interface0["IHaveArgumentArchive"]
click Interface0 "/api/Cake.SevenZip.Arguments/IHaveArgumentArchive"
Type-.->Interface1["IHaveArgumentFiles"]
click Interface1 "/api/Cake.SevenZip.Arguments/IHaveArgumentFiles"
Type-.->Interface2["IHaveArgumentDirectories"]
click Interface2 "/api/Cake.SevenZip.Arguments/IHaveArgumentDirectories"
Type-.->Interface3["IHaveArgument"]
click Interface3 "/api/Cake.SevenZip.Arguments/IHaveArgument"
Type["BaseAddLikeSyntaxCommand"]
class Type type-node
Derived0["AddCommand"]-->Type
click Derived0 "/api/Cake.SevenZip.Commands/AddCommand"
Derived1["DeleteCommand"]-->Type
click Derived1 "/api/Cake.SevenZip.Commands/DeleteCommand"
Derived2["UpdateCommand"]-->Type
click Derived2 "/api/Cake.SevenZip.Commands/UpdateCommand"
Syntax
public abstract class BaseAddLikeSyntaxCommand : BaseCommand, IHaveArgumentArchive,
IHaveArgumentFiles, IHaveArgumentDirectories, IHaveArgument
Attributes
Type | Description |
---|---|
Nullable |
|
NullableAttribute |
Constructors
Name | Summary |
---|---|
Base |
Properties
Name | Value | Summary |
---|---|---|
Archive | FilePath |
Sets the archive the command operates on.
|
CommandChar | string |
Gets the command character. (e.g. "a", "u" or "e"...)
Inherited from BaseCommand
|
CommandName | string |
Gets the name of the command. (i.e. "add", "update" or "extract".)
|
Directories | Directory |
Gets or sets the list of Directories the command operates on.
For add and update, adding a directory will add the directory itself to the root of the archive including everything in it. |
DirectoryContents | Directory |
Gets or sets the list of Directory-contents the command operates on.
For add and update, adding a directory this way will add the files of the directory to the root of the archive but not the directory itself. |
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:
Will result in an archive:
without any directory structure.
|
Switches | IEnumerable |
Gets all supported switches.
Inherited from BaseCommand
|
Throw |
bool |
Gets a value indicating whether to throw on missing input files.
|
Methods
Name | Value | Summary |
---|---|---|
BuildArgumentParams |
void |
adds only the arguments to the builder. (i.e. Archive, files, directories).
|
BuildArguments |
void |
Builds the arguments.
Inherited from BaseCommand
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp 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
|