Class CommandDefinition

Describes the lexical structure of a command.

Inheritance

System.Object

CommandDefinition

Namespace: Petabridge.Cmd

Assembly: cs.temp.dll.dll

Syntax

public sealed class CommandDefinition : INoSerializationVerificationNeeded

Constructors

CommandDefinition(String, String, IEnumerable<CommandArgument>)

Creates a new command definition.

Declaration

public CommandDefinition(string name, string description, IEnumerable<CommandArgument> arguments)

Parameters

Type	Name	Description
System.String	name	The name of the command.
System.String	description	The human-readable description of the command.
IEnumerable<CommandArgument>	arguments	The arguments provided.

Properties

Arguments

Declaration

public IReadOnlyDictionary<string, CommandArgument> Arguments { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, CommandArgument>

ArgumentsByName

Declaration

public IReadOnlyDictionary<string, CommandArgument> ArgumentsByName { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, CommandArgument>

Description

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

Name

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Type

Declaration

public CommandType Type { get; }

Property Value

Type	Description
CommandType

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32