org.biojava.utils
Class AssertionFailure

java.lang.Object
  java.lang.Throwable
      java.lang.Error
          java.lang.AssertionError
              org.biojava.utils.AssertionFailure

All Implemented Interfaces:

Serializable

public class AssertionFailure

extends AssertionError

An unchecked exception representing an Assertion failure.

Assertion failures should be raised when code finds itself in a state that should be impossible. It should not be raised in response to any predictable error condition. Assertion failures indicate that something has gone badly wrong, and that the assumptions under which library code has been developed are not holding.

This extends AssertionError, adding convenient constructors with messages and causes.

Since:

1.4

Author:

Matthew Pocock

See Also:

Serialized Form

For general use:

Your application may exit due to one of these being thrown. This usualy indicates that something is badly wrong with library code. It should never be raised in response to invalid arguments to methods, or incorrectly formatted data. It is not your fault. Report the error to the mailing list, or who ever else is responsible for the library code you are using.

For advanced users:

Under some rare circumstances, you may wish to catch assertion failures. For example, when debugging library code, or when the success or failure of an opperation is utterly inconsequential. Ignoring assertion failures out-of-hand is a sure-fire way to make your code buggy.

For developers:

Raise AssertionFailure in your code when something that should be impossible has happened. For example, if you have checked the alphabet of a symbol list you are working with, and somewhere further down an IllegalSymbolException is raised, then this is an assertion failure.

Constructor Summary

AssertionFailure(String message)

AssertionFailure(String message, Throwable cause)

AssertionFailure(Throwable cause)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AssertionFailure

public AssertionFailure(String message)

AssertionFailure

public AssertionFailure(Throwable cause)

AssertionFailure

public AssertionFailure(String message,
                        Throwable cause)