uk.ac.starlink.ttools.plot2.config
Class ConfigException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by uk.ac.starlink.ttools.plot2.config.ConfigException
All Implemented Interfaces:
Serializable

public class ConfigException
extends Exception

Exception thrown when a configuration input value is not suitable.

Since:
26 Feb 2013
Author:
Mark Taylor
See Also:
Serialized Form

Constructor Summary
ConfigException(ConfigKey<?> key, String msg, Throwable cause)
          Constructor with chained exception.
ConfigException(ConfigKey key, String msg)
          Constructor.
 
Method Summary
 ConfigKey<?> getConfigKey()
          Returns the key whose value this exception applies to.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConfigException

public ConfigException(ConfigKey<?> key,
                       String msg,
                       Throwable cause)
Constructor with chained exception.

Parameters:
key - key whose value was being solicited when the error occurred
msg - error message, may reference value but should not name key
cause - chained exception, if any

ConfigException

public ConfigException(ConfigKey key,
                       String msg)
Constructor.

Parameters:
key - key whose value was being solicited when the error occurred
msg - error message, may reference value but should not name key
Method Detail

getConfigKey

public ConfigKey<?> getConfigKey()
Returns the key whose value this exception applies to.

Returns:
config key


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.