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
|
package Perl::Critic::Exception::Configuration::Option::Global::ParameterValue;
use 5.010001;
use strict;
use warnings;
use Readonly;
use Perl::Critic::Utils qw{ :characters };
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
use Exception::Class (
'Perl::Critic::Exception::Configuration::Option::Global::ParameterValue' => {
isa => 'Perl::Critic::Exception::Configuration::Option::Global',
description => 'A problem with the value of a global parameter.',
alias => 'throw_global_value',
},
);
#-----------------------------------------------------------------------------
Readonly::Array our @EXPORT_OK => qw< throw_global_value >;
#-----------------------------------------------------------------------------
sub full_message {
my ( $self ) = @_;
my $source = $self->source();
if ($source) {
$source = qq{ found in "$source"};
}
else {
$source = $EMPTY;
}
my $option_name = $self->option_name();
my $option_value =
defined $self->option_value()
? $DQUOTE . $self->option_value() . $DQUOTE
: '<undef>';
my $message_suffix = $self->message_suffix() || $EMPTY;
return
qq{The value for the global "$option_name" option }
. qq{($option_value)$source $message_suffix};
}
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords
=head1 NAME
Perl::Critic::Exception::Configuration::Option::Global::ParameterValue - A problem with the value of a global parameter.
=head1 DESCRIPTION
A representation of a problem found with the value of a global
parameter, whether from a F<.perlcriticrc>, another profile file, or
command line.
=head1 INTERFACE SUPPORT
This is considered to be a public class. Any changes to its interface
will go through a deprecation cycle.
=head1 CLASS METHODS
=over
=item C<< throw( option_name => $option_name, option_value => $option_value, source => $source, message_suffix => $message_suffix ) >>
See L<Exception::Class/"throw">.
=item C<< new( option_name => $option_name, option_value => $option_value, source => $source, message_suffix => $message_suffix ) >>
See L<Exception::Class/"new">.
=back
=head1 METHODS
=over
=item C<full_message()>
Provide a standard message for global configuration problems. See
L<Exception::Class/"full_message">.
=back
=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 :
|