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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
package Perl::Critic::Exception::Configuration::Option;
use 5.010001;
use strict;
use warnings;
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
use Perl::Critic::Exception::Fatal::Internal;
use Exception::Class ( # this must come after "use P::C::Exception::*"
'Perl::Critic::Exception::Configuration::Option' => {
isa => 'Perl::Critic::Exception::Configuration',
description => 'A problem with an option in the Perl::Critic configuration, whether from a file or a command line or some other source.',
fields => [ qw{ option_name option_value message_suffix } ],
},
);
#-----------------------------------------------------------------------------
sub message {
my $self = shift;
return $self->full_message();
}
#-----------------------------------------------------------------------------
sub error {
my $self = shift;
return $self->full_message();
}
#-----------------------------------------------------------------------------
## no critic (Subroutines::RequireFinalReturn)
sub full_message {
Perl::Critic::Exception::Fatal::Internal->throw(
'Subclass failed to override abstract method.'
);
}
## use critic
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords
=head1 NAME
Perl::Critic::Exception::Configuration::Option - A problem with an option in the L<Perl::Critic|Perl::Critic> configuration.
=head1 DESCRIPTION
A representation of a problem found with an option in the
configuration of L<Perl::Critic|Perl::Critic>, whether from a
F<.perlcriticrc>, another profile file, or command line.
This is an abstract class. It should never be instantiated.
=head1 INTERFACE SUPPORT
This is considered to be a public class. Any changes to its interface
will go through a deprecation cycle.
=head1 METHODS
=over
=item C<option_name()>
The name of the option that was found to be in error.
=item C<option_value()>
The value of the option that was found to be in error.
=item C<message_suffix()>
Any text that should be applied to end of the standard message for
this kind of exception.
=item C<message()>
=item C<error()>
Overridden to call C<full_message()>. I.e. any message string in the
superclass is ignored.
=item C<full_message()>
Overridden to turn it into an abstract method to force subclasses to
implement it.
=back
=head1 SEE ALSO
L<Perl::Critic::Exception::Configuration::Option::Global|Perl::Critic::Exception::Configuration::Option::Global>,
L<Perl::Critic::Exception::Configuration::Option::Policy|Perl::Critic::Exception::Configuration::Option::Policy>
=head1 AUTHOR
Elliot Shank <perl@galumph.com>
=head1 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.
=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 :
|
