1Perl::Critic::PolicyParUasPmeeerrtleC:ro::nC:trBrieithbiaucvt:ie:odPro:Pl:eiErcnlyuPmDaeorrcaaumtmeietonentr(a:3t:)iBoenhavior::Enumeration(3)
2
3
4

NAME

6       Perl::Critic::PolicyParameter::Behavior::Enumeration - Actions
7       appropriate for an enumerated value.
8

DESCRIPTION

10       Provides a standard set of functionality for an enumerated
11       Perl::Critic::PolicyParameter so that the developer of a policy does
12       not have to provide it her/himself.
13
14       NOTE: Do not instantiate this class.  Use the singleton instance held
15       onto by Perl::Critic::PolicyParameter.
16

INTERFACE SUPPORT

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

METHODS

22       "initialize_parameter( $parameter, $specification )"
23           Plug in the functionality this behavior provides into the
24           parameter, based upon the configuration provided by the
25           specification.
26
27           This behavior looks for two configuration items:
28
29           enumeration_values
30               Mandatory.  The set of valid values for the parameter, as an
31               array reference.
32
33           enumeration_allow_multiple_values
34               Optional, defaults to false.  Should the parameter support a
35               single value or accept multiple?
36
37       "generate_parameter_description( $parameter )"
38           Create a description of the parameter, based upon the description
39           on the parameter itself, but enhancing it with information from
40           this behavior.
41
42           In this specific case, the universe of values is added at the end.
43

AUTHOR

45       Elliot Shank <perl@galumph.com>
46

48       Copyright (c) 2006-2011 Elliot Shank.
49
50       This program is free software; you can redistribute it and/or modify it
51       under the same terms as Perl itself.  The full text of this license can
52       be found in the LICENSE file included with this module.
53
54
55
56perl v5.28.1           Perl::Criti2c0:1:9P-o0l2i-c0y2Parameter::Behavior::Enumeration(3)
Impressum