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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Exception/Fatal.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::Fatal;
   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::Fatal' => {
  20         isa         => 'Perl::Critic::Exception',
  21         description =>
  22             'A problem that should cause Perl::Critic to stop running.',
  23     },
  24 );
  25
  26 #-----------------------------------------------------------------------------
  27
  28 sub new {
  29     my ($class, @args) = @_;
  30     my $self = $class->SUPER::new(@args);
  31
  32     $self->show_trace(1);
  33
  34     return $self;
  35 }
  36
  37 #-----------------------------------------------------------------------------
  38
  39 sub full_message {
  40     my ( $self ) = @_;
  41
  42     return
  43           $self->short_class_name()
  44         . q{: }
  45         . $self->description()
  46         . "\n\n"
  47         . $self->message()
  48         . "\n\n"
  49         . gmtime $self->time()
  50         . "\n\n";
  51 }
  52
  53
  54 1;
  55
  56 __END__
  57
  58 #-----------------------------------------------------------------------------
  59
  60 =pod
  61
  62 =for stopwords
  63
  64 =head1 NAME
  65
  66 Perl::Critic::Exception::Fatal - A problem that should cause L<Perl::Critic> to stop running.
  67
  68 =head1 DESCRIPTION
  69
  70 Something went wrong and processing should not continue.  You should
  71 never specifically look for this exception or one of its subclasses.
  72
  73 Note: the constructor invokes L<Exception::Class/"show_trace"> to
  74 force stack-traces to be included in the standard stringification.
  75
  76 This is an abstract class.  It should never be instantiated.
  77
  78
  79 =head1 METHODS
  80
  81 =over
  82
  83 =item C<full_message()>
  84
  85 Overrides L<Exception::Class/"full_message"> to include extra information.
  86
  87
  88 =back
  89
  90
  91 =head1 AUTHOR
  92
  93 Elliot Shank <perl@galumph.com>
  94
  95 =head1 COPYRIGHT
  96
  97 Copyright (c) 2007-2008 Elliot Shank.  All rights reserved.
  98
  99 This program is free software; you can redistribute it and/or modify
 100 it under the same terms as Perl itself.  The full text of this license
 101 can be found in the LICENSE file included with this module.
 102
 103 =cut
 104
 105 # Local Variables:
 106 #   mode: cperl
 107 #   cperl-indent-level: 4
 108 #   fill-column: 78
 109 #   indent-tabs-mode: nil
 110 #   c-indentation-style: bsd
 111 # End:
 112 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :