lib/Catalyst/Exception.pm

   1 package Catalyst::Exception;
   2
   3 # XXX: See bottom of file for Exception implementation
   4
   5 package Catalyst::Exception::Base;
   6
   7 use Moose;
   8 use Carp;
   9 use namespace::clean -except => 'meta';
  10
  11 =head1 NAME
  12
  13 Catalyst::Exception - Catalyst Exception Class
  14
  15 =head1 SYNOPSIS
  16
  17    Catalyst::Exception->throw( qq/Fatal exception/ );
  18
  19 See also L<Catalyst>.
  20
  21 =head1 DESCRIPTION
  22
  23 This is the Catalyst Exception class.
  24
  25 =head1 METHODS
  26
  27 =head2 throw( $message )
  28
  29 =head2 throw( message => $message )
  30
  31 =head2 throw( error => $error )
  32
  33 Throws a fatal exception.
  34
  35 =cut
  36
  37 has message => (
  38     is  => 'ro',
  39     isa => 'Str',
  40 );
  41
  42 sub throw {
  43     my $class  = shift;
  44     my %params = @_ == 1 ? ( error => $_[0] ) : @_;
  45
  46     my $message = $params{message} || $params{error} || $! || '';
  47
  48     local $Carp::CarpLevel = 1;
  49
  50     croak($message);
  51 }
  52
  53 =head2 meta
  54
  55 Provided by Moose
  56
  57 =head1 AUTHORS
  58
  59 Catalyst Contributors, see Catalyst.pm
  60
  61 =head1 COPYRIGHT
  62
  63 This library is free software. You can redistribute it and/or modify
  64 it under the same terms as Perl itself.
  65
  66 =cut
  67
  68 Catalyst::Exception::Base->meta->make_immutable;
  69
  70 package Catalyst::Exception;
  71
  72 use Moose;
  73 use namespace::clean -except => 'meta';
  74
  75 use vars qw[$CATALYST_EXCEPTION_CLASS];
  76
  77 BEGIN {
  78     extends($CATALYST_EXCEPTION_CLASS || 'Catalyst::Exception::Base');
  79 }
  80
  81 __PACKAGE__->meta->make_immutable;
  82
  83 1;