Search code examples
javaassert

Correct use Java "assert" keyword


I have never understood what is assert used for, even though I have read plenty examples, they don't really let me know what or why should I use it for.

So Instead of asking an example, I'm gonna provide one and let me know if this is the proper usage of assert.

// The idea is that the `mode` variable should be 0 or 1, and no other number.
switch(mode) {
     case 0: 
          // do stuff
          break;
     case 1:
          // do other stuff
          break;

     default:
          // assert code?
}

If this is correct, please let me know how to use it in this case. If this is not how it is supposed to use, please provide an example.


Solution

  • Not in this case.

    If you're asserting a value, you're making a statement that, before some critical evaluation is done using this value, that it is what you assert it to be. You can assert that the value isn't null, or that it's less than 2, or something before you reach your critical code block.

    assert (mode >= 0 && mode < 2);  // Ensures that `mode` is between 0 and 1.
    // Switch statement to follow
    

    I would not encourage the use of that here. Your code would not read well, and unless you enable assertions with the -ea flag, your assertion would not work.

    Instead, what you can do is throw an exception of some kind - if it's not 0 or 1, then the mode is an illegal value which cannot be processed, leading to exceptional/undefined behavior. Throw an exception of some kind.

    switch(mode) {
        case 0: 
            // do stuff
            break;
        case 1:
            // do other stuff
            break;
        default:
          throw new IllegalArgumentException("Mode is illegal");
    }