Class ElementCommand<TEntity>

Namespace

TypedRest.CommandLine.Commands.Generic

Assembly

TypedRest.CommandLine.dll

Command operating on an IElementEndpoint<TEntity>.

public class ElementCommand<TEntity> : EndpointCommand<IElementEndpoint<TEntity>>, IEndpointCommand where TEntity : class

Type Parameters

TEntity

The type of entity the endpoint represents.

Inheritance

object

EndpointCommand<IElementEndpoint<TEntity>>

ElementCommand<TEntity>

Implements

IEndpointCommand

Derived

PollingCommand<TEntity>

Inherited Members

EndpointCommand<IElementEndpoint<TEntity>>.Endpoint

EndpointCommand<IElementEndpoint<TEntity>>.Console

EndpointCommand<IElementEndpoint<TEntity>>.ExecuteAsync(IReadOnlyList<string>, CancellationToken)

EndpointCommand<IElementEndpoint<TEntity>>.GetSubCommand(string)

EndpointCommand<IElementEndpoint<TEntity>>.Input<T>(IReadOnlyList<string>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ElementCommand(IElementEndpoint<TEntity>)

Command operating on an IElementEndpoint<TEntity>.

public ElementCommand(IElementEndpoint<TEntity> endpoint)

Parameters

endpoint IElementEndpoint<TEntity>

The endpoint this command operates on.

Methods

ExecuteInnerAsync(IReadOnlyList<string>, CancellationToken)

Parses command-line arguments and executes the resulting operation when no additional sub-IEndpointCommand is specified.

protected override Task ExecuteInnerAsync(IReadOnlyList<string> args, CancellationToken cancellationToken = default)

Parameters

args IReadOnlyList<string>

the console arguments.

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task

InputEntity(IReadOnlyList<string>)

Acquires a TEntity from the user, e.g. by parsing the args or via JSON on the console.

protected virtual TEntity InputEntity(IReadOnlyList<string> args)

Parameters

args IReadOnlyList<string>

Returns

TEntity

OutputEntity(TEntity)

Outputs a TEntity to the user via the console.

protected virtual void OutputEntity(TEntity entity)

Parameters

entity TEntity