diff options
| author | fukachan <fukachan> | 2011-09-25 22:06:43 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2011-09-25 22:06:43 +0000 |
| commit | b653588fd14399a3acd1aca1f77e0bced91f804d (patch) | |
| tree | 8b38123b40248927cc1d31187e69684b610109a2 /fml | |
| parent | c3659cea5d607a9ca69b7fa69616ea36cee8b36c (diff) | |
| download | fml8-b653588fd14399a3acd1aca1f77e0bced91f804d.tar.gz fml8-b653588fd14399a3acd1aca1f77e0bced91f804d.tar.bz2 fml8-b653588fd14399a3acd1aca1f77e0bced91f804d.zip | |
modified to not use this top level package. remove this.
Diffstat (limited to 'fml')
| -rw-r--r-- | fml/lib/ErrorStatus.pm | 140 |
1 files changed, 0 insertions, 140 deletions
diff --git a/fml/lib/ErrorStatus.pm b/fml/lib/ErrorStatus.pm deleted file mode 100644 index e4130c16..00000000 --- a/fml/lib/ErrorStatus.pm +++ /dev/null @@ -1,140 +0,0 @@ -#-*- perl -*- -# -# Copyright (C) 2001,2002,2003,2004,2005 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.10 2004/07/23 13:16:30 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: 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: set the error message within $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,2004,2005 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; |
