From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

ELLIOTJS / Perl-Critic-1.099_001 / lib / Perl / Critic / PolicyParameter / Behavior.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
—
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

              
##############################################################################
#      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/distributions/Perl-Critic/lib/Perl/Critic/PolicyParameter/Behavior.pm $
#     $Date: 2009-06-25 18:47:12 -0400 (Thu, 25 Jun 2009) $
#   $Author: clonezone $
# $Revision: 3360 $
##############################################################################
package Perl::Critic::PolicyParameter::Behavior;
use 5.006001;
use strict;
use warnings;
use Perl::Critic::Utils qw{ :characters };
our $VERSION = '1.099_001';
#-----------------------------------------------------------------------------
sub new {
    my $class = shift;
    return bless {}, $class;
}
#-----------------------------------------------------------------------------
sub initialize_parameter {
    my ($self, $parameter, $specification) = @_;
    return;
}
#-----------------------------------------------------------------------------
sub generate_parameter_description {
    my ($self, $parameter) = @_;
    return $parameter->_get_description_with_trailing_period();
}
#-----------------------------------------------------------------------------
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords
=head1 NAME
Perl::Critic::PolicyParameter::Behavior - Default type-specific actions for a parameter.
=head1 DESCRIPTION
Provides a standard set of functionality for a
L<Perl::Critic::PolicyParameter|Perl::Critic::PolicyParameter> so that
the developer of a policy does not have to provide it her/himself.
The developer can override most of the functionality in the
subclasses; these are just defaults.
All subclasses have singleton instances held onto by
L<Perl::Critic::PolicyParameter|Perl::Critic::PolicyParameter>.
=head1 INTERFACE SUPPORT
This is considered to be a non-public class.  Its interface is subject
to change without notice.
=head1 METHODS
=over
=item C<initialize_parameter( $parameter, $specification )>
Plug in the functionality this behavior provides into the parameter,
based upon the configuration provided by the specification.  The
configuration items looked for depends upon the specific behavior
subclass.
=item C<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.
Note that this may return C<undef> if the parameter itself doesn't
have a description.  Also, the returned value may include multiple
lines.
=back
=head1 AUTHOR
Elliot Shank <perl@galumph.com>
=head1 COPYRIGHT
Copyright (c) 2006-2009 Elliot Shank.  All rights reserved.
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.
=cut
# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 78
#   indent-tabs-mode: nil
#   c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :