HeadsCommand Class

Summary

This class implements the "hg heads" command (): show current repository heads or show branch heads.
Assembly
Mercurial.Net.dll
Namespace
Mercurial
Interfaces
Base Types
graph TD Base0["MercurialCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial/MercurialCommandBase_1" Base1["CommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial/CommandBase_1" Base2["object"]-->Base1 Interface0["IMercurialCommand<TResult>"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial/IMercurialCommand_1" Interface1["IMercurialCommand"]-.->Type click Interface1 "/Cake.Hg/api/Mercurial/IMercurialCommand" Interface2["ICommand"]-.->Type click Interface2 "/Cake.Hg/api/Mercurial/ICommand" Type["HeadsCommand"] class Type type-node

Syntax

public sealed class HeadsCommand : MercurialCommandBase<HeadsCommand>, 
    IMercurialCommand<IEnumerable<Changeset>>, IMercurialCommand, ICommand

Constructors

Name Summary
HeadsCommand() Initializes a new instance of the HeadsCommand 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.
BranchRevisions Collection<T>
Gets the collection of Revision, if non-empty, will only include heads associated with the branches these revisions are on. Default is empty.
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>
Observer IMercurialCommandObserver
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase<T>
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>
Result IEnumerable<T>
Gets the result of executing the command as a collection of Changeset objects.
Revision RevSpec
Gets or sets the Revision to get heads of, if non-null will only include heads that are descendants of the specified revision. Default is null.
ShowClosed bool
Gets or sets a value indicating whether to include closed branches in the collection. 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>
Topological bool
Gets or sets a value indicating whether to show topological branches only (branches without children.) Default is false.

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
Parses the standard output for results.
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.)
Inherited from CommandBase<T>
WithAdditionalArgument(string) T
Adds the value to the AdditionalArguments collection property and returns this instance.
Inherited from CommandBase<T>
WithBranchRevision(RevSpec) HeadsCommand
Adds the value to the BranchRevisions collection property and returns this HeadsCommand instance.
WithConfigurationOverride(string, string, string) void
Adds a configuration override specification to the AdditionalArguments collection in the form of section.name=value.
WithObserver(IMercurialCommandObserver) T
Sets the Observer property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithRevision(RevSpec) HeadsCommand
Sets the Revision property to the specified value and returns this HeadsCommand instance.
WithShowClosed(bool) HeadsCommand
Sets the ShowClosed property to the specified value and returns this HeadsCommand instance.
WithTimeout(int) T
Sets the Timeout property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithTopological(bool) HeadsCommand
Sets the Topological property to the specified value and returns this HeadsCommand instance.

Extension Methods

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