Class CommandLineApplication<TModel>

Describes a set of command line arguments, options, and execution behavior using a type of TModel to model the application.

Inheritance
System.Object
CommandLineApplication
CommandLineApplication<TModel>
Implements
System.IServiceProvider
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: McMaster.Extensions.CommandLineUtils
Assembly: McMaster.Extensions.CommandLineUtils.dll
Syntax
public class CommandLineApplication<TModel> : CommandLineApplication, IServiceProvider, IDisposable, IModelAccessor where TModel : class
Type Parameters
Name Description
TModel

Constructors

| Improve this Doc View Source

CommandLineApplication(IHelpTextGenerator, IConsole, String, Boolean)

Initializes a new instance of CommandLineApplication.

Declaration
public CommandLineApplication(IHelpTextGenerator helpTextGenerator, IConsole console, string workingDirectory, bool throwOnUnexpectedArg)
Parameters
Type Name Description
IHelpTextGenerator helpTextGenerator

The help text generator to use.
IConsole console

The console implementation to use.
System.String workingDirectory

The current working directory.
System.Boolean throwOnUnexpectedArg

Initial value for ThrowOnUnexpectedArgument.
| Improve this Doc View Source

CommandLineApplication(IConsole)

Initializes a new instance of CommandLineApplication.

Declaration
public CommandLineApplication(IConsole console)
Parameters
Type Name Description
IConsole console

The console implementation to use.
| Improve this Doc View Source

CommandLineApplication(IConsole, String, Boolean)

Initializes a new instance of CommandLineApplication.

Declaration
public CommandLineApplication(IConsole console, string workingDirectory, bool throwOnUnexpectedArg)
Parameters
Type Name Description
IConsole console

The console implementation to use.
System.String workingDirectory

The current working directory.
System.Boolean throwOnUnexpectedArg

Initial value for ThrowOnUnexpectedArgument.
| Improve this Doc View Source

CommandLineApplication(Boolean)

Initializes a new instance of CommandLineApplication.

Declaration
public CommandLineApplication(bool throwOnUnexpectedArg = true)
Parameters
Type Name Description
System.Boolean throwOnUnexpectedArg

Initial value for ThrowOnUnexpectedArgument.

Properties

| Improve this Doc View Source

Model

An instance of the model associated with the command line application.

Declaration
public TModel Model { get; }
Property Value
Type Description
TModel
| Improve this Doc View Source

ModelFactory

Defines the function that produces an instance of TModel.

Declaration
public Func<TModel> ModelFactory { get; set; }
Property Value
Type Description
System.Func<TModel>

Methods

| Improve this Doc View Source

CreateModel()

Create an instance of TModel.

Declaration
protected virtual TModel CreateModel()
Returns
Type Description
TModel

An instance of the context.
| Improve this Doc View Source

Dispose()

Declaration
public override void Dispose()
Overrides
| Improve this Doc View Source

HandleParseResult(ParseResult)

Handle the result of parsing command line arguments.

Declaration
protected override void HandleParseResult(ParseResult parseResult)
Parameters
Type Name Description
ParseResult parseResult

The parse result.
Overrides

Explicit Interface Implementations

| Improve this Doc View Source

IModelAccessor.GetModel()

Declaration
object IModelAccessor.GetModel()
Returns
Type Description
System.Object
| Improve this Doc View Source

IModelAccessor.GetModelType()

Declaration
Type IModelAccessor.GetModelType()
Returns
Type Description
System.Type

Implements

System.IServiceProvider
System.IDisposable

Extension Methods