CODEWITHSUNDEEP
c#exception
fhnaseer
fhnaseer

Reputation: 7277

Should my method throw its own exception, or let .NET throw if a file doesn't exist?

Here is my code:

public void ReadSomeFile(string filePath)
{
    if (!File.Exists(filePath))
        throw new FileNotFoundException();

    var stream = new FileStream(filePath, ....)
    .....
}

Should I throw an exception myself (see the File.Exists check)? FileStream will already throw FileNotFoundException if the the file doesn't exist. What is good programming practice here? Code analysis says that we should validate our parameters. But if I am passing that parameter directly to another method (mine or someone else code) and that method will throw exception itself, then what is advantage of validating argument in my code?

Upvotes: 76

Views: 7138

Answers (4)

Amir Saniyan
Amir Saniyan

Reputation: 13759

Let the correct method try to open the file while you don't have any idea about full file name, somethings like special file names (eg. Device files and UNC paths):

In some cases other file methods may be failed, but opening the file is successful.

Some examples for special file names are:

  • CON
  • NUL
  • COM1, COM2, COM3, COM4
  • \\server\share\file_path
  • \\teela\admin$\system32 (to reach C:\WINNT\system32)
  • C:..\File.txt
  • \\.\COM1
  • %TEMP%
  • and more...

Upvotes: 0

Stephan Bijzitter
Stephan Bijzitter

Reputation: 4595

Aside from the already-given answers, you could also say that this depends on what you expect to happen.

If you want to read a log file and it does not exist, do you want to throw an error, or just an empty String (or empty String array)?

If returning a default value (like an empty String) I would simply wrap the content of the function in a try-catch (but only for expected errors) and return the default in the catch block, while returning the actual content in the try block.

This would leave three possible situations:

  1. The content of a file is returned;
  2. The default value is returned, because an expected error occurred;
  3. An error is thrown by .NET, because you did not catch that specific error.

Upvotes: 1

Ian Ringrose
Ian Ringrose

Reputation: 51927

Your method is called ReadSomeFile and takes a filename as its input, therefore it is reasonable for it to throw a FileNotFoundException. As you cannot add any value by catching the exception then throwing it yourself, just let .NET throw it.

However if your method was LoadData(databaseName) and it has to access many files, catching the exception, and throwing a custom exception may be of value, as you could add the databaseName to the exception along with other helpful information.

Upvotes: 15

CodeCaster
CodeCaster

Reputation: 151674

if (File.Exists(f)) { DoSomething(f) } (or the negation thereof) is an anti-pattern. The file can be deleted or created in between those two statements, so it makes little sense to check its existence like that.

Apart from that, as pointed out in the comments, while File.Exists() may return true, the actual opening of the file can then still fail for a variety of reasons. So you'll have to repeat the error checking and throwing around the opening of the file.

As you don't want to repeat yourself but instead keep your code DRY, just attempt to open the file and let new FileStream() throw. Then you can catch the exception, and if you wish, re-throw the original or throw an application-specific exception.

Of course calling File.Exists() can be justified, but not in this pattern.

Upvotes: 118

Related Questions