NAME¶
Perl::Critic::PolicyParameter::Behavior::Enumeration - Actions appropriate for
an enumerated value.
DESCRIPTION¶
Provides a standard set of functionality for an enumerated
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 two configuration items:
- enumeration_values
- Mandatory. The set of valid values for the parameter, as an
array reference.
- enumeration_allow_multiple_values
- Optional, defaults to false. Should the parameter support a
single value or accept multiple?
- "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 universe of values is 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.