Current File : //usr/share/perl5/vendor_perl/Throwable/Error.pm
package Throwable::Error;
BEGIN {
$Throwable::Error::VERSION = '0.102080';
}
use Moose 0.87;
with 'Throwable', 'StackTrace::Auto';
# ABSTRACT: an easy-to-use class for error objects
use overload
q{""} => 'as_string',
fallback => 1;
has message => (
is => 'ro',
isa => 'Str',
required => 1,
);
sub as_string {
my ($self) = @_;
my $str = $self->message;
$str .= "\n\n" . $self->stack_trace->as_string;
return $str;
}
sub BUILDARGS {
my ($self, @args) = @_;
return {} unless @args;
return {} if @args == 1 and ! defined $args[0];
if (@args == 1 and (!ref $args[0]) and defined $args[0] and length $args[0]) {
return { message => $args[0] };
}
return $self->SUPER::BUILDARGS(@args);
}
__PACKAGE__->meta->make_immutable(inline_constructor => 0);
no Moose;
1;
__END__
=pod
=head1 NAME
Throwable::Error - an easy-to-use class for error objects
=head1 VERSION
version 0.102080
=head1 SYNOPSIS
package MyApp::Error;
use Moose;
extends 'Throwable::Error';
has execution_phase => (
is => 'ro',
isa => 'MyApp::Phase',
default => 'startup',
);
...and in your app...
MyApp::Error->throw("all communications offline");
# or...
MyApp::Error->throw({
message => "all communications offline",
phase => 'shutdown',
});
=head1 DESCRIPTION
Throwable::Error is a base class for exceptions that will be thrown to signal
errors and abort normal program flow. Throwable::Error is an alternative to
L<Exception::Class|Exception::Class>, the features of which are largely
provided by the Moose object system atop which Throwable::Error is built.
Throwable::Error performs the L<Throwable|Throwable> and L<StackTrace::Auto>
roles. That means you can call C<throw> on it to create and throw n error
object in one call, and that every error object will have a stack trace for its
creation.
=head1 ATTRIBUTES
=head2 message
This attribute must be defined and must contain a string describing the error
condition. This string will be printed at the top of the stack trace when the
error is stringified.
=head2 stack_trace
This attribute, provided by L<StackTrace::Auto>, will contain a stack trace
object guaranteed to respond to the C<as_string> method. For more information
about the stack trace and associated behavior, consult the L<StackTrace::Auto>
docs.
=head1 METHODS
=head2 as_string
This method will provide a string representing the error, containing the
error's message followed by the its stack trace.
=head1 AUTHORS
=over 4
=item *
Ricardo SIGNES <rjbs@cpan.org>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
Mini Shell