cern.gp.util

Class Assertion

java.lang.Object

cern.gp.util.Assertion

public class Assertion
extends java.lang.Object

An assertion class, that enables programmers to make certain affirmations about things that have to be true in the code. If an assertion is broken, this means that there is a bad error in the code. Often, assertions are used in to assure that the parameters of a function call are correct, e.g. if a non-null parameter has been passed.

Author:

Vito Baggiolini

Constructor Summary

Constructors

Constructor and Description
Assertion()

Method Summary

Modifier and Type	Method and Description
static boolean	assertTrue(boolean booleanCond, java.lang.String stringCond) Assert a function to assert a certain property of the code.
static void	main(java.lang.String[] args) The main program for the Assert class

Methods inherited from class java.lang.Object

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

Constructor Detail

Assertion

public Assertion()

Method Detail

assertTrue

public static boolean assertTrue(boolean booleanCond,
                                 java.lang.String stringCond)

Assert a function to assert a certain property of the code. If the asserted property is false, the Assertion is violated and an RuntimeException is thrown.

For example, assert that str is non-null:

  void myFunction(String str) { Assert.assertTrue(str != null, "str != null"); }
   


  Example: make sure min <= max: 

  boolean compare(int min, int max) { Assert.assertTrue(min <= max, "min <=
  max"); }
 


  Example: make sure that num is greater or equal 0: 


  

  double squareRoot(double num) { Assert.assertTrue(num >= 0, "num >= 0"); }
   

Parameters:

booleanCond - the condition expressed as a boolean

stringCond - the same condition, given as a String. This is used to fill in the error message in the Exception that is launched if the Assertion is violated.

Returns:

the condition, which in this implementation is always true (a RuntimeException is thrown on false condition)

Throws:

java.lang.RuntimeException - if the Assertion is violated. The message in the exception is the string in the stringCond parameter.

main

public static void main(java.lang.String[] args)

The main program for the Assert class

Parameters:

args - The command line arguments