Build all packages removed dependencies of libtest-exception-perl libtest-warn-perl...
[dh-make-perl] / dev / i386 / libperl-critic-perl / libperl-critic-perl-1.088 / lib / Perl / Critic / Exception / Configuration / Option.pm
diff --git a/dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Exception/Configuration/Option.pm b/dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Exception/Configuration/Option.pm
new file mode 100644 (file)
index 0000000..a996200
--- /dev/null
@@ -0,0 +1,142 @@
+##############################################################################
+#      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Exception/Configuration/Option.pm $
+#     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
+#   $Author: clonezone $
+# $Revision: 2489 $
+##############################################################################
+
+package Perl::Critic::Exception::Configuration::Option;
+
+use 5.006001;
+use strict;
+use warnings;
+
+our $VERSION = '1.088';
+
+#-----------------------------------------------------------------------------
+
+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> configuration.
+
+=head1 DESCRIPTION
+
+A representation of a problem found with an option in the
+configuration of L<Perl::Critic>, whether from a F<.perlcriticrc>,
+another profile file, or command line.
+
+This is an abstract class.  It should never be instantiated.
+
+
+=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>
+L<Perl::Critic::Exception::Configuration::Option::Policy>
+
+
+=head1 AUTHOR
+
+Elliot Shank <perl@galumph.com>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2007-2008 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 :