cmd_flag

cmd_type

Option to mark if this attribute should be used as an option or parameter value.

Allowed values are:

option - Command line option

proto - Command line option that should be processed prior to other options (eg. a config-file option that sets other attribues) Usually only used for plugin developmemt

parameter - Positional parameter command line value

cmd_env

Environment variable name (only uppercase letters, numeric and underscores allowed). If variable was not specified otherwise the value will be taken from %ENV.

cmd_aliases

Arrayref of alternative option names

cmd_tags

Extra option tags displayed in the usage information (in brackets)

cmd_position

Override the order of the parameters in the usage message.

cmd_split

Splits multiple values at the given separator string or regular expression. Only works in conjunction with an 'ArrayRef[*]' type constraint (isa). ie. '--myattr value1,value2' with cmd_split set to ',' would produce an arrayref with to elements.

cmd_count

Similar to the Getopt::Long '+' modifier, cmd_count turns the attribute into a counter. Every occurence of the attribute in @ARGV (without any value) would increment the resulting value by one

METHODS

These methods are only of interest to plugin authors.

cmd_name_possible

my @names = $attribute->cmd_name_possible();

Returns a list of all possible option names.

cmd_name_primary

my $name = $attribute->cmd_name_primary();

Returns the primary option name

cmd_usage_name

my $name = $attribute->cmd_usage_name();

Returns the name as used by the usage text

cmd_usage_description

my $name = $attribute->cmd_usage_description();

Returns the description as used by the usage text

cmd_tags_list

my @tags = $attribute->cmd_tags_list();

Returns a list of tags

cmd_has_value

my $has_value = $attribute->cmd_has_value();

Indicates if an commandline attribute has a value. Usually attributes with a boolean type constraint or counters don't have values.

undef: Does not have a boolean type constraint

true: Has a boolean type constraint

false: Has a boolean type constraint, and a true default value

cmd_type_constraint_check

$attribute->cmd_type_constraint_check($value)

Checks the type constraint. Returns an error message if the check fails