blob: 2980fd0c2c2014a07476ac60cbe08b0ad389be4b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
#-*- perl -*-
#
# Copyright (C) 2001 Ken'ichi Fukamachi
# All rights reserved. This program is free software; you can
# redistribute it and/or modify it under the same terms as Perl itself.
#
# $Id$
# $FML$
#
package File::Errors;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK);
use Carp;
require Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(error_reason error error_reset);
=head1 NAME
File::Errors - error handling utilities
=head1 SYNOPSIS
Consider C<Something> class module
package Something;
use File::Errors qw(error_reason error error_reset);
sub xxx
{
if something errors ...
$self->error_reason( error reason );
}
You use C<Something> module like this.
use Something;
$obj = new Something;
$obj->xxx();
unless ($obj->error) { $obj->do_somting( ...); };
=head1 DESCRIPTION
simple utility functions to manipulate error messages.
=head1 METHODS
=head2 C<error_reason($message)>
save $message as an error message.
=head2 C<error()>
return $message which is saved by C<error_reason($msg)>.
=cut
sub error_reason
{
my ($self, $mesg) = @_;
$self->{'_error_reason'} = $mesg;
}
sub error
{
my ($self, $args) = @_;
return $self->{'_error_reason'};
}
sub error_reset
{
my ($self, $args) = @_;
my $msg = $self->{'_error_reason'};
undef $self->{'_error_reason'} if defined $self->{'_error_reason'};
undef $self->{'_error_action'} if defined $self->{'_error_action'};
return $msg;
}
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
File::Errors appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
