git.maemo.org Git - pkg-perl/blob - deb-src/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Exception.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Exception.pm $
   3 #     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
   4 #   $Author: clonezone $
   5 # $Revision: 2489 $
   6 ##############################################################################
   7
   8 package Perl::Critic::Exception;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13
  14 our $VERSION = '1.088';
  15
  16 #-----------------------------------------------------------------------------
  17
  18 use Exception::Class (
  19     'Perl::Critic::Exception' => {
  20         isa         => 'Exception::Class::Base',
  21         description => 'A problem discovered by Perl::Critic.',
  22     },
  23 );
  24
  25 use base 'Exporter';
  26
  27 #-----------------------------------------------------------------------------
  28
  29 sub short_class_name {
  30     my ( $self ) = @_;
  31
  32     return substr ref $self, (length 'Perl::Critic') + 2;
  33 }
  34
  35 #-----------------------------------------------------------------------------
  36
  37
  38 1;
  39
  40 __END__
  41
  42 #-----------------------------------------------------------------------------
  43
  44 =pod
  45
  46 =for stopwords
  47
  48 =head1 NAME
  49
  50 Perl::Critic::Exception - A problem identified by L<Perl::Critic>.
  51
  52 =head1 DESCRIPTION
  53
  54 A base class for all problems discovered by L<Perl::Critic>.  This
  55 exists to enable differentiating exceptions from L<Perl::Critic> code
  56 from those originating in other modules.
  57
  58 This is an abstract class.  It should never be instantiated.
  59
  60
  61 =head1 METHODS
  62
  63 =over
  64
  65 =item C<short_class_name()>
  66
  67 Retrieve the name of the class of this object with C<'Perl::Critic::'>
  68 stripped off.
  69
  70
  71 =back
  72
  73
  74 =head1 AUTHOR
  75
  76 Elliot Shank <perl@galumph.com>
  77
  78 =head1 COPYRIGHT
  79
  80 Copyright (c) 2007-2008 Elliot Shank.  All rights reserved.
  81
  82 This program is free software; you can redistribute it and/or modify
  83 it under the same terms as Perl itself.  The full text of this license
  84 can be found in the LICENSE file included with this module.
  85
  86 =cut
  87
  88 # Local Variables:
  89 #   mode: cperl
  90 #   cperl-indent-level: 4
  91 #   fill-column: 78
  92 #   indent-tabs-mode: nil
  93 #   c-indentation-style: bsd
  94 # End:
  95 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :