Package elki.utilities.optionhandling

Class ParameterException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    WrongParameterValueException
    public class ParameterException
extends java.lang.Exception
    Abstract super class for all exceptions thrown during parameterization.
    Since:
    0.1
    Author:
    Elke Achtert
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static long serialVersionUID
      Serialization version

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String prefixParametersToMessage​(Parameter<?> p, java.lang.String mid, Parameter<?> p2, java.lang.String message)
      Prefix parameters to error message.
      static java.lang.String prefixParameterToMessage​(Parameter<?> p, java.lang.String message)
      Prefix parameter information to error message.

      • Methods inherited from class java.lang.Throwable

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Serialization version
        See Also:
        Constant Field Values

    • Constructor Detail

      • ParameterException

        public ParameterException​(Parameter<?> p,
                          java.lang.String message)
        Constructor.
        Parameters:
        p - Parameter
        message - Error message

      • ParameterException

        public ParameterException​(Parameter<?> p,
                          java.lang.String message,
                          java.lang.Throwable cause)
        Constructor.
        Parameters:
        p - Parameter
        message - Error message
        cause - root cause

      • ParameterException

        public ParameterException​(java.lang.String message)
        Constructor.
        Parameters:
        message - Error message

      • ParameterException

        public ParameterException​(java.lang.String message,
                          java.lang.Throwable cause)
        Constructor.
        Parameters:
        message - Error message
        cause - root cause

    • Method Detail

      • prefixParameterToMessage

        public static java.lang.String prefixParameterToMessage​(Parameter<?> p,
                                                        java.lang.String message)
        Prefix parameter information to error message.
        Parameters:
        p - Parameter
        message - Error message
        Returns:
        Combined error message

      • prefixParametersToMessage

        public static java.lang.String prefixParametersToMessage​(Parameter<?> p,
                                                         java.lang.String mid,
                                                         Parameter<?> p2,
                                                         java.lang.String message)
        Prefix parameters to error message.
        Parameters:
        p - Parameter
        p2 - Parameter
        message - Error message
        Returns:
        Combined error message