Package gov.nih.mipav.model.scripting.parameters

Class ParameterException

  • All Implemented Interfaces:
    java.io.Serializable
    public class ParameterException
extends java.lang.RuntimeException
    Exception indicating an error encounted while retrieving a script parameter (i.e., it doesn't exist or is of an unexpected type).
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String parameterLabel
      The label of the parameter which there was an error retrieving.

    • Constructor Summary

      Constructors 
      Constructor Description
      ParameterException​(java.lang.String paramLabel, java.lang.String message)
      Create a new ParameterException.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getParameterLabel()
      Return the parameter label which caused this parameter exception.
      void setParameterLabel​(java.lang.String paramLabel)
      Change the parameter label which caused this parameter exception.
      java.lang.String toString()
      Returns a string representing the information contained in this exception.

      • Methods inherited from class java.lang.Throwable

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • parameterLabel

        private java.lang.String parameterLabel
        The label of the parameter which there was an error retrieving.

    • Constructor Detail

      • ParameterException

        public ParameterException​(java.lang.String paramLabel,
                          java.lang.String message)
        Create a new ParameterException.
        Parameters:
        paramLabel - The parameter label requested, which then caused the error.
        message - A message describing the error.

    • Method Detail

      • setParameterLabel

        public void setParameterLabel​(java.lang.String paramLabel)
        Change the parameter label which caused this parameter exception.
        Parameters:
        paramLabel - The label of the parameter which we tried to retrieve from the parameter table.

      • getParameterLabel

        public java.lang.String getParameterLabel()
        Return the parameter label which caused this parameter exception.
        Returns:
        The label of the parameter which we tried to retrieve from the parameter table.

      • toString

        public java.lang.String toString()
        Returns a string representing the information contained in this exception.
        Overrides:
        toString in class java.lang.Throwable
        Returns:
        A string containing info about this error.