1Params::CallbackRequestU:s:eErxcCeopnttiroinbsu(t3e)d PePralraDmosc:u:mCeanltlabtaicoknRequest::Exceptions(3)
2
6 Params::CallbackRequest::Exceptions - Parameter callback exception
7 definitions
8
10 use Params::CallbackRequest::Exceptions;
11 Params::Callback::Exception::Execution->throw("Whoops!");
12 use Params::CallbackRequest::Exceptions abbr => [qw(throw_cb_exec)];
14 throw_cb_exec "Whoops!";
15
17 This module creates the exceptions used by Params::CallbackRequest and
18 Params::Callback. The exceptions are subclasses of
19 Exception::Class::Base, created by the interface defined by
20 Exception::Class.
21
23 Exported Functions
24 This module exports two functions by default.
25 "isa_cb_exception"
27 eval { something_that_dies() };
29 if (my $err = $@) {
30 if (isa_cb_exception($err, 'Abort')) {
31 print "All hands abandon ship!";
32 } elsif (isa_cb_exception($err)) {
33 print "I recall an exceptional fault.";
34 } else {
35 print "No clue.";
36 }
37 }
38 This function takes a single argument and returns true if it's a
40 Params::Callback::Exception object. A second, optional argument can be
41 used to identify a particular subclass of Params::Callback::Exception.
42 "rethrow_exception"
44 eval { something_that_dies() };
46 if (my $err = $@) {
47 # Do something intelligent, and then...
48 rethrow_exception($err);
49 }
50 This function takes an exception as its sole argument and rethrows it.
52 If the argument is an object that "can('throw')", such as any subclass
53 of Exception::Class, then "rethrow_exception()" will call its rethrow
54 method. If not, but the argument is a reference, "rethrow_exception()"
55 will simply die with it. And finally, if the argument is not a
56 reference at all, "rethrow_exception()" will throw a new
57 Params::Callback::Exception exception with the argument used as the
58 exception error message.
59 Abbreviated Exception Functions
61 Each of the exception classes created by
63 Params::CallbackRequest::Exceptions has a functional alias for its
64 throw class method. These may be imported by passing an array reference
65 of the names of the abbreviated functions to import via the "abbr"
66 parameter:
67 use Params::CallbackRequest::Exceptions abbr => [qw(throw_cb_exec)];
69 The names of the abbreviated functions are:
71 throw_cb
73 Params::Callback::Exception
74 throw_bad_key
76 Params::Callback::Exception::InvalidKey
77 throw_cb_exec
79 Params::Callback::Exception::Execution
80 throw_bad_params
82 Params::Callback::Exception::Params
83 throw_abort
85 Params::Callback::Exception::Abort
86 Exception Classes
88 The exception classes created by Params::Callback::Exception are as
89 follows:
90 Params::Callback::Exception
92 This is the base class for all Params::Callback exception classes. Its
94 functional alias is "throw_cb".
95 Params::Callback::Exception::InvalidKey
97 Params::CallbackRequest throws this exception when a callback key in
99 the parameter hash passed to "new()" has no corresponding callback. In
100 addition to the attributes offered by Exception::Class::Base, this
101 class also features the attribute "callback_key". Use the
102 "callback_key()" accessor to see what callback key triggered the
103 exception. Params::Callback::Exception::InvalidKey's functional alias
104 is "throw_bad_key".
105 Params::Callback::Exception::Execution
107 This is the exception thrown by Params::CallbackRequest's default
109 exception handler when a callback subroutine or method dies. In
110 addition to the attributes offered by Exception::Class::Base, this
111 class also features the attributes "callback_key", which corresponds to
112 the parameter key that triggered the callback, and "callback_error"
113 which is the error thrown by the callback subroutine or method.
114 Params::Callback::Exception::Execution's functional alias is
115 "throw_cb_exec".
116 Params::Callback::Exception::Params
118 This is the exception thrown when an invalid parameter is passed to
120 Params::CallbackRequest's or Params::Callback's "new()" constructors.
121 Its functional alias is "throw_bad_params".
122 Params::Callback::Exception::Abort
124 This is the exception thrown by Params::Callback's "abort()" method.
126 functional alias is "throw_cb". In addition to the attributes offered
127 by Exception::Class::Base, this class also features the attribute
128 "aborted_value" attribute. Use the "aborted_value()" accessor to see
129 what value was passed to "abort()".
130 Params::Callback::Exception::Abort's functional alias is "throw_abort".
131
133 Params::Callback is the base class for all callback classes.
134 Params::CallbackRequest sets up callbacks for execution.
136 Exception::Class defines the interface for the exception classes
138 created here.
139
141 This module is stored in an open GitHub repository
142 <http://github.com/theory/params-callbackrequest/>. Feel free to fork
143 and contribute!
144 Please file bug reports via GitHub Issues
146 <http://github.com/theory/params-callbackrequest/issues/> or by sending
147 mail to bug-params-callbackrequest@rt.cpan.org <mailto:bug-params-
148 callbackrequest@rt.cpan.org>.
149
151 David E. Wheeler <david@justatheory.com>
152
154 Copyright 2003-2011 David E. Wheeler. Some Rights Reserved.
155 This library is free software; you can redistribute it and/or modify it
157 under the same terms as Perl itself.
158perl v5.34.0 2021-07P-a2r2ams::CallbackRequest::Exceptions(3)