Perl::Critic::PolicyParameter::Behavior::Integer - Actions appropriate for an integer parameter.


Perl-Critic documentation  | view source Contained in the Perl-Critic distribution.

Index


NAME

Top

Perl::Critic::PolicyParameter::Behavior::Integer - Actions appropriate for an integer parameter.

DESCRIPTION

Top

Provides a standard set of functionality for an integer Perl::Critic::PolicyParameter so that the developer of a policy does not have to provide it her/himself.

The parser provided by this behavior allows underscores ("_") in input values as in a Perl numeric literal.

NOTE: Do not instantiate this class. Use the singleton instance held onto by Perl::Critic::PolicyParameter.

INTERFACE SUPPORT

Top

This is considered to be a non-public class. Its interface is subject to change without notice.

METHODS

Top

initialize_parameter( $parameter, $specification )

Plug in the functionality this behavior provides into the parameter, based upon the configuration provided by the specification.

This behavior looks for two configuration items:

integer_minimum

Optional. The minimum acceptable value. Inclusive.

integer_maximum

Optional. The maximum acceptable value. Inclusive.

generate_parameter_description( $parameter )

Create a description of the parameter, based upon the description on the parameter itself, but enhancing it with information from this behavior.

In this case, this means including the minimum and maximum values.

AUTHOR

Top

Elliot Shank <perl@galumph.com>

COPYRIGHT

Top


Perl-Critic documentation  | view source Contained in the Perl-Critic distribution.