Tom Wyant > Astro-App-Satpass2 > Astro::App::Satpass2::Warner

Download:
Astro-App-Satpass2-0.020.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.020   Source  

NAME ^

Astro::App::Satpass2::Warner - Output warning and error messages

SYNOPSIS ^

 use Astro::App::Satpass2::Warner

 my $warner = Astro::App::Satpass2::Warner->new();
 $warner->whinge( 'This is a warning, or a carp' );
 $warner->wail( 'This is a die, or a croak' );

DESCRIPTION ^

This class is private to the Astro::App::Satpass2 package. The author reserves the right to modify or revoke it without notice. The documentation is purely for the benefit of the author.

This class manages the reporting of error messages, generating them by either warn and c<die>, or carp and croak as the user desires. If the warn attribute is true, you get warn or die. If false, you get carp or croak.

METHODS ^

This class supports the following public methods:

new

This static method instantiates an Astro::App::Satpass2::Warner object. It takes as arguments name/value pairs which will be passed to the relevant subroutine. It is probably only useful to set warning.

wail

This method concatenates all its arguments, and passes them to die (if the warn attribute is true) or croak (if the warn attribute is false).

warning

If called without an argument, this method returns the value of the warning attribute. If called with an argument, it sets the value of the warning attribute.

The initial value of the attribute is false.

weep

This method concatenates all its arguments, prefixes 'Programming Error - ', and passes them to Carp::confess().

whinge

This method concatenates all its arguments, and passes them to warn (if the warn attribute is true) or carp (if the warn attribute is false).

Nothing is returned.

SUPPORT ^

Support is by the author. Please file bug reports at http://rt.cpan.org, or in electronic mail to the author.

AUTHOR ^

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE ^

Copyright (C) 2011-2014 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

syntax highlighting: