Jeffrey Ryan Thalhammer > Perl-Critic-1.120 > Perl::Critic::PolicyParameter::Behavior::Integer

Download:
Perl-Critic-1.120.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  61
Open  120
Stalled  4
View/Report Bugs
Module Version: 1.120   Source   Latest Release: Perl-Critic-1.122

NAME ^

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

DESCRIPTION ^

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 ^

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

METHODS ^

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 ^

Elliot Shank <perl@galumph.com>

COPYRIGHT ^

Copyright (c) 2007-2011 Elliot Shank.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.

syntax highlighting: