blob: 88b8ab746ea06779a7fdc40711e74fca768ea322 (
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003 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.
#
# $FML: ErrorStatus.pm,v 1.7 2003/02/16 02:36:31 fukachan Exp $
#
package ErrorStatus;
#
# XXX-TODO: we should not use ErrorStatus module, is'nt it?
# XXX-TODO: FML/Config.pm
# XXX-TODO: FML/Credential.pm
# XXX-TODO: FML/Filter.pm
# XXX-TODO: FML/Filter/Header.pm
# XXX-TODO: FML/Filter/MimeComponent.pm
# XXX-TODO: FML/Filter/MimeComponent3.pm
# XXX-TODO: FML/Filter/TextPlain.pm
# XXX-TODO: File/Sequence.pm
# XXX-TODO: File/SimpleLock.pm
#
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK);
use Carp;
require Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(errstr error error_set error_clear);
=head1 NAME
ErrorStatus - error handling component
=head1 SYNOPSIS
Use this module in your C<Something> class module like this:
package Something;
use ErrorStatus qw(errstr error error_set error_clear);
sub xxx
{
if something errors ...
$self->error_set( why this error occurs ... );
}
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 error_set($message)
save $message as an error message.
=head2 error()
return $message which is saved by C<error_set($msg)>.
=cut
# Descriptions: save the error message in $self object.
# Arguments: OBJ($self) STR($mesg)
# Side Effects: update OBJ
# Return Value: STR
sub error_set
{
my ($self, $mesg) = @_;
$self->{'_error_reason'} = $mesg if defined $mesg;
}
# Descriptions: get the error message.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: STR
sub error
{
my ($self) = @_;
return $self->{'_error_reason'} ? $self->{'_error_reason'} : undef;
}
# Descriptions: get the error message.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: STR
sub errstr
{
my ($self) = @_;
return $self->error();
}
# Descriptions: clear the error message buffer.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: STR (cleared message)
sub error_clear
{
my ($self) = @_;
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 CODING STYLE
See C<http://www.fml.org/software/FNF/> on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001,2002,2003 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
ErrorStatus first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
