.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Log::Report::Exception 3pm"
.TH Log::Report::Exception 3pm "2023-10-29" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Log::Report::Exception \- a collected report
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\& # created within a try block
\& try { error "help!" };
\& my $exception = $@\->wasFatal;
\& $exception\->throw if $exception;
\&
\& $@\->reportFatal;  # combination of above two lines
\&
\& my $message = $exception\->message;   # the Log::Report::Message
\&
\& if($message\->inClass(\*(Aqdie\*(Aq)) ...
\& if($exception\->inClass(\*(Aqdie\*(Aq)) ...   # same
\& if($@\->wasFatal(class => \*(Aqdie\*(Aq)) ... # same
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In Log::Report, exceptions are not as extended as available in
languages as Java: you do not create classes for them.  The only
thing an exception object does, is capture some information about
an (untranslated) report.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
.IP "Log::Report::Exception\->\fBnew\fR(%options)" 4
.IX Item "Log::Report::Exception->new(%options)"
.Vb 4
\& \-Option     \-\-Default
\&  message      <required>
\&  reason       <required>
\&  report_opts  {}
.Ve
.RS 4
.IP "message => Log::Report::Message" 2
.IX Item "message => Log::Report::Message"
.PD 0
.IP "reason => \s-1REASON\s0" 2
.IX Item "reason => REASON"
.IP "report_opts => \s-1HASH\s0" 2
.IX Item "report_opts => HASH"
.RE
.RS 4
.RE
.PD
.SS "Accessors"
.IX Subsection "Accessors"
.ie n .IP "$obj\->\fBisFatal\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBisFatal\fR()" 4
.IX Item "$obj->isFatal()"
Returns whether this exception has a severity which makes it fatal
when thrown. [1.34] This can have been overruled with the \f(CW\*(C`is_fatal\*(C'\fR
attribute.  See \fBLog::Report::Util::is_fatal()\fR.
.Sp
example:
.Sp
.Vb 2
\&  if($ex\->isFatal) { $ex\->throw(reason => \*(AqALERT\*(Aq) }
\&  else { $ex\->throw }
.Ve
.ie n .IP "$obj\->\fBmessage\fR( [$message] )" 4
.el .IP "\f(CW$obj\fR\->\fBmessage\fR( [$message] )" 4
.IX Item "$obj->message( [$message] )"
Change the \f(CW$message\fR of the exception, must be a Log::Report::Message
object.
.Sp
When you use a \f(CW\*(C`Log::Report::Message\*(C'\fR 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.
.Sp
example:
.Sp
.Vb 3
\& $e\->message\->concat(\*(Aq!!\*(Aq)); # will not work!
\& $e\->message($e\->message\->concat(\*(Aq!!\*(Aq));
\& $e\->message(_\|_x"some message {msg}", msg => $xyz);
.Ve
.ie n .IP "$obj\->\fBreason\fR( [$reason] )" 4
.el .IP "\f(CW$obj\fR\->\fBreason\fR( [$reason] )" 4
.IX Item "$obj->reason( [$reason] )"
.PD 0
.ie n .IP "$obj\->\fBreport_opts\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBreport_opts\fR()" 4
.IX Item "$obj->report_opts()"
.PD
.SS "Processing"
.IX Subsection "Processing"
.ie n .IP "$obj\->\fBinClass\fR($class|Regexp)" 4
.el .IP "\f(CW$obj\fR\->\fBinClass\fR($class|Regexp)" 4
.IX Item "$obj->inClass($class|Regexp)"
Check whether any of the classes listed in the message match \f(CW$class\fR
(string) or the Regexp.  This uses \fBLog::Report::Message::inClass()\fR.
.ie n .IP "$obj\->\fBprint\fR( [$fh] )" 4
.el .IP "\f(CW$obj\fR\->\fBprint\fR( [$fh] )" 4
.IX Item "$obj->print( [$fh] )"
The default filehandle is \s-1STDOUT.\s0
.Sp
example:
.Sp
.Vb 2
\& print $exception;  # via overloading
\& $exception\->print; # OO style
.Ve
.ie n .IP "$obj\->\fBthrow\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBthrow\fR(%options)" 4
.IX Item "$obj->throw(%options)"
Insert the message contained in the exception into the currently
defined dispatchers.  The \f(CW\*(C`throw\*(C'\fR name is commonly known
exception related terminology for \f(CW\*(C`report\*(C'\fR.
.Sp
The \f(CW%options\fR overrule the captured options to \fBLog::Report::report()\fR.
This can be used to overrule a destination.  Also, the reason can
be changed.
.Sp
example: overrule defaults to report
.Sp
.Vb 2
\& try { report {to => \*(Aqstderr\*(Aq}, ERROR => \*(Aqoops!\*(Aq };
\& $@\->reportFatal(to => \*(Aqsyslog\*(Aq);
\&
\& $exception\->throw(to => \*(Aqsyslog\*(Aq);
\&
\& $@\->wasFatal\->throw(reason => \*(AqWARNING\*(Aq);
.Ve
.ie n .IP "$obj\->\fBtoHTML\fR( [$locale] )" 4
.el .IP "\f(CW$obj\fR\->\fBtoHTML\fR( [$locale] )" 4
.IX Item "$obj->toHTML( [$locale] )"
[1.11] as \fBtoString()\fR, and escape \s-1HTML\s0 volatile characters.
.ie n .IP "$obj\->\fBtoString\fR( [$locale] )" 4
.el .IP "\f(CW$obj\fR\->\fBtoString\fR( [$locale] )" 4
.IX Item "$obj->toString( [$locale] )"
Prints the reason and the message.  Differently from \fBthrow()\fR, this
only represents the textual content: it does not re-cast the exceptions to
higher levels.
.Sp
example: printing exceptions
.Sp
.Vb 2
\& print $_\->toString for $@\->exceptions;
\& print $_ for $@\->exceptions;   # via overloading
.Ve
.SH "OVERLOADING"
.IX Header "OVERLOADING"
.IP "overload: \fBstringification\fR" 4
.IX Item "overload: stringification"
Produces \*(L"reason: message\*(R".
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report distribution version 1.36,
built on October 27, 2023. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2023 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://dev.perl.org/licenses/\fR