Jeffrey Ryan Thalhammer > Perl-Critic-1.122 > Perl::Critic::PolicyParameter::Behavior::StringList

Download:
Perl-Critic-1.122.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.122   Source  

NAME ^

Perl::Critic::PolicyParameter::Behavior::StringList - Actions appropriate for a parameter that is a list of strings.

DESCRIPTION ^

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

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 one configuration item:

always_present_values

Optional. Values that should always be included, regardless of what the configuration of the parameter specifies, as an array reference.

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 specific case, the always present values are added at the end.

AUTHOR ^

Elliot Shank <perl@galumph.com>

COPYRIGHT ^

Copyright (c) 2006-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: