Package localsolver

Class LSException

  • All Implemented Interfaces:
    java.io.Serializable
    public class LSException
extends java.lang.RuntimeException
    LocalSolver exception. If an error occurred, LocalSolver throws a specific exception which contains useful info for debugging purposes.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      LSErrorCode getErrorCode()
      Returns the error code associated to this exception.
      java.lang.String getExplanation()
      Gets the explanation about the exception.
      java.lang.String getFileName()
      Gets the name of the LocalSolver source file where the exception is thrown.
      java.lang.String getFunctionName()
      Gets the name of the function where the exception is thrown.
      int getLineNumber()
      Gets the line number in the LocalSolver source file where the exception is thrown.
      java.lang.String getMessage()
      Returns a String message with all useful info about the current exception.
      java.lang.String toString()
      Same as getMessage().

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getFileName

        public java.lang.String getFileName()
        Gets the name of the LocalSolver source file where the exception is thrown. Only useful for LocalSolver's maintenance team.
        Returns:
        File name.

      • getLineNumber

        public int getLineNumber()
        Gets the line number in the LocalSolver source file where the exception is thrown. Only useful for LocalSolver's maintenance team.
        Returns:
        Line number.

      • getFunctionName

        public java.lang.String getFunctionName()
        Gets the name of the function where the exception is thrown.
        Returns:
        Function name.

      • getExplanation

        public java.lang.String getExplanation()
        Gets the explanation about the exception.
        Returns:
        Explanation.

      • getMessage

        public java.lang.String getMessage()
        Returns a String message with all useful info about the current exception.
        Overrides:
        getMessage in class java.lang.Throwable
        Returns:
        Exception message.

      • getErrorCode

        public LSErrorCode getErrorCode()
        Returns the error code associated to this exception.
        Returns:
        Error code.

      • toString

        public java.lang.String toString()
        Same as getMessage().
        Overrides:
        toString in class java.lang.Throwable