Summary

This class implements the "hg add" command (): add the specified files on the next commit.

Assembly

Mercurial.Net.dll

Namespace

Interfaces

Base Types

graph TD Base0["IncludeExcludeCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial/IncludeExcludeCommandBase_1" Base1["MercurialCommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial/MercurialCommandBase_1" Base2["CommandBase<T>"]-->Base1 click Base2 "/Cake.Hg/api/Mercurial/CommandBase_1" Base3["object"]-->Base2 Interface0["IMercurialCommand"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial/IMercurialCommand" Interface1["ICommand"]-.->Type click Interface1 "/Cake.Hg/api/Mercurial/ICommand" Type["AddCommand"] class Type type-node

Syntax

public sealed class AddCommand : IncludeExcludeCommandBase<AddCommand>, IMercurialCommand, ICommand

Constructors

Name	Summary
AddCommand()	Initializes a new instance of the `AddCommand` class.

Properties

Name	Value	Summary
AdditionalArguments	Collection<T>	Gets the collection which additional arguments can be added into. This collection is exposed for extensions, so that they have a place to add all their extra arguments to the Mercurial command line client. Inherited from CommandBase<T>
Arguments	IEnumerable<T>	Gets all the arguments to the `Command`, or an empty array if there are none.
Command	string	Gets the command to execute with the Mercurial command line client. Inherited from CommandBase<T>
DebugOutput	bool	Gets or sets a value indicating whether to enable debug output on the command. This should only be used by the command code itself, never by the user. Inherited from CommandBase<T>
ExcludePatterns	Collection<T>	Gets the collection of filename patterns to exclude for the command. Inherited from IncludeExcludeCommandBase<T>
IncludePatterns	Collection<T>	Gets the collection of filename patterns to include for the command. Inherited from IncludeExcludeCommandBase<T>
Observer	IMercurialCommandObserver	Gets or sets the object that will act as an observer of command execution. Inherited from CommandBase<T>
Paths	Collection<T>	Gets the collection of path patterns to add to the repository.
RawExitCode	int	Gets the raw exit code from executing the command line client. Inherited from CommandBase<T>
RawStandardErrorOutput	string	Gets the raw standard error output from executing the command line client. Inherited from CommandBase<T>
RawStandardOutput	string	Gets the raw standard output from executing the command line client. Inherited from CommandBase<T>
RecurseSubRepositories	bool	Gets or sets a value indicating whether to recurse into subrepositories. Default is `false`.
Timeout	int	Gets or sets the timeout to use when executing Mercurial commands, in seconds. Default is 60. Inherited from CommandBase<T>

Methods

Name	Value	Summary
AddArgument(string)	void	Adds the specified argument to the `AdditionalArguments` collection, unless it is already present. Inherited from CommandBase<T>
After(int, string, string)	void	This method is called after the command has been executed. You can use this to clean up after the command execution (like removing temporary files), and to react to the exit code from the command line client. If the exit code is considered a failure, this method should throw the correct exception. Inherited from CommandBase<T>
Before()	void	This method is called before the command is executed. You can use this to store temporary files (like a commit message or similar) that the `Arguments` refer to, before the command is executed. Inherited from CommandBase<T>
Cleanup()	void	Override this method to implement code that will execute after command line execution.
ParseStandardOutputForResults(int, string)	void	This method should parse and store the appropriate execution result output according to the type of data the command line client would return for the command. Inherited from CommandBase<T>
Prepare()	void	Override this method to implement code that will execute before command line execution. Inherited from CommandBase<T>
RequiresVersion(Version, string)	void	This method will check the current client version and throw a `System.NotSupportedException` if the current client version is older than the required one. Inherited from MercurialCommandBase<T>
ThrowOnUnsuccessfulExecution(int, string)	void	This method should throw the appropriate exception depending on the contents of the exitCode and standardErrorOutput parameters, or simply return if the execution is considered successful. Inherited from CommandBase<T>
Validate()	void	Validates the command configuration. This method should throw the necessary exceptions to signal missing or incorrect configuration (like attempting to add files to the repository without specifying which files to add.)
WithAdditionalArgument(string)	T	Adds the value to the `AdditionalArguments` collection property and returns this instance. Inherited from CommandBase<T>
WithConfigurationOverride(string, string, string)	void	Adds a configuration override specification to the `AdditionalArguments` collection in the form of `section.name=value`. Inherited from MercurialCommandBase<T>
WithExcludePattern(string)	T	Adds the value to the `ExcludePatterns` collection property and returns this instance. Inherited from IncludeExcludeCommandBase<T>
WithIncludePattern(string)	T	Adds the value to the `IncludePatterns` collection property and returns this instance. Inherited from IncludeExcludeCommandBase<T>
WithObserver(IMercurialCommandObserver)	T	Sets the `Observer` property to the specified value and returns this instance. Inherited from CommandBase<T>
WithPaths(string[])	AddCommand	Adds all the values to the `Paths` collection property and returns this `AddCommand` instance.
WithRecurseSubRepositories(bool)	AddCommand	Sets the `RecurseSubRepositories` property to the specified value and returns this `AddCommand` instance.
WithTimeout(int)	T	Sets the `Timeout` property to the specified value and returns this instance. Inherited from CommandBase<T>

Extension Methods