csheets.core.formula.util
Class CircularReferenceException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by csheets.core.formula.util.ExpressionVisitorException
                  extended by csheets.core.formula.util.CircularReferenceException
All Implemented Interfaces:
Serializable

public class CircularReferenceException
extends ExpressionVisitorException

An exception that is thrown if a formula contains a reference (directly or indirectly) to the cell in which it is contained.

Author:
Einar Pehrson
See Also:
Serialized Form

Constructor Summary
CircularReferenceException(Formula formula)
          Creates a new circular reference exception.
 
Method Summary
 boolean equals(Object other)
          Returns whether the other object is an identical value .
 Formula getFormula()
          Returns the formula in which the circularity exists.
 String toString()
          Returns a string representation of the exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CircularReferenceException

public CircularReferenceException(Formula formula)
Creates a new circular reference exception.

Parameters:
formula - the formula that caused the exception
Method Detail

getFormula

public Formula getFormula()
Returns the formula in which the circularity exists.

Returns:
the formula in which the circularity exists

toString

public String toString()
Returns a string representation of the exception.

Overrides:
toString in class Throwable
Returns:
a string representation of the exception

equals

public boolean equals(Object other)
Returns whether the other object is an identical value .

Overrides:
equals in class Object
Parameters:
other - the object to check for equality
Returns:
true if the objects are equal