METHODS

Constructors

$class->new( OPTIONS )
Option Default

message

<required>

reason

<required>

report_opts

{}

message => Log::Report::Message
reason => REASON
report_opts => HASH

Accessors

$obj->isFatal

Returns whether this exception has a severity which makes it fatal when thrown. See Log::Report::isFatal().

» Example:
  if($ex->isFatal) { $ex->throw(reason => 'ALERT') }
  else { $ex->throw }
$obj->message( [MESSAGE] )

Change the MESSAGE of the exception, must be a Log::Report::Message object.

When you use a Log::Report::Message object, you will get a new one returned. Therefore, if you want to modify the message in an exception, you have to re-assign the result of the modification.

» Example:
 $e->message->concat('!!')); # will not work!
 $e->message($e->message->concat('!!'));
 $e->message(__x"some message {msg}", msg => $xyz);
$obj->reason( [REASON] )
$obj->report_opts

Processing

$obj->inClass( CLASS|REGEX )

Check whether any of the classes listed in the message match CLASS (string) or the REGEX. This uses Log::Report::Message::inClass().

$obj->print( [FILEHANDLE] )

The default filehandle is STDOUT.

» Example:
 print $exception;  # via overloading
 $exception->print; # OO style
$obj->throw( OPTIONS )

Insert the message contained in the exception into the currently defined dispatchers. The throw name is commonly known exception related terminology for report.

The OPTIONS overrule the captured options to Log::Report::report(). This can be used to overrule a destination. Also, the reason can be changed.

» Example: overrule defaults to report
 try { print {to => 'stderr'}, ERROR => 'oops!' };
 $@->reportFatal(to => 'syslog');

 $exception->throw(to => 'syslog');

 $@->wasFatal->throw(reason => 'WARNING');
$obj->toString

Prints the reason and the message. Differently from throw(), this only represents the textual content: it does not re-cast the exceptions to higher levels.

» Example: printing exceptions
 print $_->toString for $@->exceptions;
 print $_ for $@->exceptions;   # via overloading