G. Wade Johnson > App-CmdDispatch-0.4 > App::CmdDispatch::Exception

Download:
App-CmdDispatch-0.4.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.4   Source   Latest Release: App-CmdDispatch-0.41

NAME ^

App::CmdDispatch::Exception - Define exception objects used by CmdDispatch modules.

VERSION ^

This document describes App::CmdDispatch::Exception version 0.4

SYNOPSIS ^

    use App::CmdDispatch::Exception;

    die App::CmdDispatch::Exception::MissingCommand->new();

DESCRIPTION ^

These exception classes simplify exceptional conditions that need a bit more context to report that the simple fact of the exception. These are used in the parts of the run code where we want to catch the exception and perform some recovery.

Other places in the code where we just want to leave the program, I've thrown simple strings instead.

INTERFACE ^

new( @args )

Create an exception object. Store the supplied args if necessary to explain context of exception.

why()

Method returning a string with a user-readable string explaining the exception.

CONFIGURATION AND ENVIRONMENT ^

App::CmdDispatch::Exception requires no configuration files or environment variables.

DEPENDENCIES ^

None.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

AUTHOR ^

G. Wade Johnson wade@anomaly.org

LICENCE AND COPYRIGHT ^

Copyright (c) 2013, G. Wade Johnson wade@anomaly.org. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: