All Classes, Interfaces, Objects and Records

Name Unit Description
IArgument Command.Interfaces

Interface representing an argument that can be registered in CommandBuilder for later use by the user.

ICommand Command.Interfaces

Interface representing a command that can be registered in CommandBuilder for later use by the user.

ICommandBuilder Command.Interfaces

Interface that represents the CommandBuilder, its main purpose is to configure the arguments, commands and options accepted by the tool. Central point of the library, responsible for comparing and validating the parameters passed via the command line against the configured parameters, later executing the callback linked to the localized command.

IOption Command.Interfaces

Interface representing an option that can be set as expected for a command.

IValidatorBase Command.Interfaces

Base interface for any validation that needs to be implemented. Specification validations need to inherit from this interface by convention from this library. It already has control for the successor validator as well as its automatic call at the appropriate time.

IValidatorContext Command.Interfaces

Interface that groups all validators, as well as establishes the validation order.

TArgument Command.Builder

Class that implements the IArgument interface that represents an argument that can be registered in CommandBuilder for later use by the user.

TColorTheme Command.Interfaces

Color theme structure used across the library. All fields in this record represent colors that can be defined from the color constants found in the Command.Colors unit.

TCommand Command.Builder

Class that implements the ICommand interface that represents a command that can be registered in CommandBuilder for later use by the user.

TCommandApp Command.App

This class allows you to define which arguments, commands, and options will be accepted as parameters by executing the application via the command line. For that it is necessary to use the TCommandApp.CommandBuilder property.

TCommandBuilder Command.Builder

Class that implements the ICommandBuilder interface, its main purpose is to configure the arguments, commands and options accepted by the tool. Central point of the library, responsible for comparing and validating the parameters passed by the command line with the configured parameters, later executing the callback linked to the localized command.

TConfiguredCommandWithCallback Command.Validator

Returns an error if a command was configured without a callback

TDuplicateArgumentValidator Command.Validator

Returns an error if a command has been passed twice. A duplicity is accepted if a command accepts another command as an argument through the ccNoArgumentsButCommands constraint.

TDuplicateOptionValidator Command.Validator

Returns an error if an option was passed twice.

TOption Command.Builder

Class that implements the IOption interface that represents an option that can be configured as expected for a command.

TProvidedArgumentsAreNotRequired Command.Validator

Returns an error if not required arguments were passed to the command and the constraint ccNoArgumentsButCommands is active for the command.

TProvidedArgumentsAreNotValid Command.Validator

Returns an error if there are commands configured for the CommandBuilder and arguments were passed via the command line, but no command was found.

TProvidedArgumentsExceedsAcceptedLimit Command.Validator

Returns an error if more arguments were passed than what was set for the command.

TSelectedCommandDoesNotAcceptCommandAsArgument Command.Validator

Returns an error if a command was passed to a command that does ot accept this type of parameter. Only works if ccNoArgumentsButCommands constraint is set for the command.

TSelectedCommandRequiresNoArguments Command.Validator

Returns an error if an argument has been passed to a command that does not require parameters. Only works if ccNoParameters is set for the command.

TSelectedCommandRequiresOneArguments Command.Validator

Returns an error if no argument has been passed to a command that requires parameters. Only works if ccRequiresOneArgument is set for the command.

TSelectedCommandRequiresOneOption Command.Validator

Returns an error if an argument has been passed to a command with out at least one option. Only works if ccRequiresOneOption is not set for the command.

TSelectedCommandRequiresValidCommandOrNothing Command.Validator

Returns an error if an invalid command was passed to a command that only accepts command as an argument. Only works if ccNoArgumentsButCommands is set for the command.

TSelectedCommandValidateIfOptionsExists Command.Validator

Returns an error if a non-existent option was passed to a command.

TSelectedCommandValidateOptionValueNotRequired Command.Validator

Returns an error if an option has been passed with a value and it is configured to not accept a value.

TSelectedCommandValidateOptionValueRequired Command.Validator

Returns an error if an option has been passed without a value and it is configured to require a value.

TSelectedCommandValidateRejectedOption Command.Validator

Returns an error if an option has been passed that cannot be used together with another option for a given command.

TValidatorBase Command.Validator

Base class for any validation that needs to be implemented. Specification validations need to inherit from this class by convention from this library. It already has control for the successor validator as well as its automatic call at the appropriate time.

TValidatorContext Command.Validator

Class that groups all validators, as well as establishes the validation order.


Generated by PasDoc 0.16.0.