ArchiveCommand Class

Summary

This class implements the "hg archive" command (): create an unversioned archive of a repository revision.
Assembly
Mercurial.Net.dll
Namespace
Mercurial
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["ArchiveCommand"] class Type type-node

Syntax

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

Constructors

Name Summary
ArchiveCommand() Initializes a new instance of the ArchiveCommand 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>
ArchiveType ArchiveType
Gets or sets the type of archive to produce. Default is Automatic.
Arguments IEnumerable<T>
Gets all the arguments to the Command, or an empty array if there are none.
Inherited from CommandBase<T>
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>
Destination string
Gets or sets the destination to archive typ, either the directory (if ArchiveType is DirectoryWithFiles) or the full path to and name of the archive file (for all other ArchiveTypes of archives.) Default value is System.String.Empty.
DirectoryPrefix string
Gets or sets a directory prefix for files in the archive. Default is System.String.Empty.
ExcludePatterns Collection<T>
Gets the collection of filename patterns to exclude for the command.
IncludePatterns Collection<T>
Gets the collection of filename patterns to include for the command.
Observer IMercurialCommandObserver
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase<T>
PassThroughDecoders bool
Gets or sets a value indicating whether to pass files through decoders before archival. Default is true.
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.
Revision RevSpec
Gets or sets the RevSpec to archive.
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.
Inherited from CommandBase<T>
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.
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>
WithArchiveType(ArchiveType) ArchiveCommand
Sets the ArchiveType property to the specified value and returns this ArchiveCommand instance.
WithConfigurationOverride(string, string, string) void
Adds a configuration override specification to the AdditionalArguments collection in the form of section.name=value.
WithDestination(string) ArchiveCommand
Sets the Destination property to the specified value and returns this ArchiveCommand instance.
WithDirectoryPrefix(string) ArchiveCommand
Sets the DirectoryPrefix property to the specified value and returns this ArchiveCommand instance.
WithExcludePattern(string) T
Adds the value to the ExcludePatterns collection property and returns this instance.
WithIncludePattern(string) T
Adds the value to the IncludePatterns collection property and returns this instance.
WithObserver(IMercurialCommandObserver) T
Sets the Observer property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithPassThroughDecoders(bool) ArchiveCommand
Sets the PassThroughDecoders property to the specified value and returns this ArchiveCommand instance.
WithRecurseSubRepositories(bool) ArchiveCommand
Sets the RecurseSubRepositories property to the specified value and returns this ArchiveCommand instance.
WithRevision(RevSpec) ArchiveCommand
Sets the Revision property to the specified value and returns this ArchiveCommand instance.
WithTimeout(int) T
Sets the Timeout property to the specified value and returns this instance.
Inherited from CommandBase<T>

Extension Methods

Name Value Summary
OperateOnPatchRepository<ArchiveCommand>() T
Makes the command operate on the patch repository instead of the main repository.