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 use overload q{""} => \&as_string;
  43
  44 sub as_string {
  45     my ($self) = @_;
  46     return $self->message;
  47 }
  48
  49 sub throw {
  50     my $class  = shift;
  51     my %params = @_ == 1 ? ( error => $_[0] ) : @_;
  52
  53     my $message = $params{message} || $params{error} || $! || '';
  54
  55     local $Carp::CarpLevel = 1;
  56
  57     croak($message);
  58 }
  59
  60 =head2 meta
  61
  62 Provided by Moose
  63
  64 =head1 AUTHORS
  65
  66 Catalyst Contributors, see Catalyst.pm
  67
  68 =head1 COPYRIGHT
  69
  70 This library is free software. You can redistribute it and/or modify
  71 it under the same terms as Perl itself.
  72
  73 =cut
  74
  75 Catalyst::Exception::Base->meta->make_immutable;
  76
  77 package Catalyst::Exception;
  78
  79 use Moose;
  80 use namespace::clean -except => 'meta';
  81
  82 use vars qw[$CATALYST_EXCEPTION_CLASS];
  83
  84 BEGIN {
  85     extends($CATALYST_EXCEPTION_CLASS || 'Catalyst::Exception::Base');
  86 }
  87
  88 __PACKAGE__->meta->make_immutable;
  89
  90 1;