NAME

        LipmError::IOException - a class to define specific exception of Input/Output


SYNOPSIS


        new LipmError::IOException($io_file [,$test_type]);

        throw LipmError::IOException('io_file' [,$test_type]);
        where $test_type is 'f' or 'file' or 'd' or 'dir' or 'directory'
        catch LipmError::IOException with {...}


DESCRIPTION

        With this class you can describe all type of exception encountered by Input/Output.
        
=head2 ERROR MESSAGES
        keyword                 =>      message
        'default'               =>      "no IO error has been found",
        'exist'                 =>      "exist",
        '!exist'                =>      "not exist",
        '!readable'             =>      "is not readable",
        '!writable'             =>      "can't be write",
        '!executable'   =>      "is not executable",
        'file'                  =>      "is a file",
        '!file'                 =>      "is not a file",
        'dir'                   =>      "is a directory",
        '!dir'                  =>      "is not a directory",
        'pipe'                  =>      "is a pipe",
        '!pipe'                 =>      "is not a pipe",
        'empty'                 =>      "this file is empty"
        
=head2 ERROR KEYS
        -handler                => handler which cause the error
        -keyword                => keyword that describe the error (see below)
        
=head1 SUBROUTINES
        Explain
        ErrorTypeToString
        TestDir
        TestFile
        TestIO


AUTHOR

        Olivier Stahl : olivier.stahl@toulouse.inra.fr

Function ErrorTypeToString

 Title        : ErrorTypeToString
 Usage        : $string = LipmError::IOException -> ErrorTypeToString($keyword);
 Prerequisite : none
 Function     : return the explanation corresponding to an error type
 Returns      : the string corresponding to the error type explanation
 Args         : $keyword -> the error type keyword
 Globals      : none

Function TestIO

 Title        : TestIO
 Usage        : $error_type = $self -> TestIO($io_file);
 Prerequisite : none
 Function     : test the io_file and return the error type
 Returns      : the keyword corresponding to the error type
 Args         : $io_file -> the name of the handler to test
 Globals      : none

TestCreate

 Title        : TestCreate
 Usage        : $error_type = $self -> TestCreate($io_file);
 Prerequisite : none
 Procedure    : test the existence and return an error
 Returns      : the keyword corresponding to the error type
 Args         : $io_file -> the name of the handler to test
 Globals      : none

TestFile

 Title        : TestFile
 Usage        : $error_type = $self -> TestFile($io_file);
 Prerequisite : none
 Function     : test the io_file to return specific file errors
 Returns      : the keyword corresponding to the error type
 Args         : $io_file -> the file to test
 Globals      : none

Function TestDir

 Title        : TestDir
 Usage        : $error_type = $self -> TestDir($io_dir);
 Prerequisite : none
 Function     : test the io_dir to return specific directory errors
 Returns      : the keyword corresponding to the error type
 Args         : $io_dir -> the directory to test
 Globals      : none