Package org.confng.api
Class ConfigurationException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- org.confng.api.ConfigurationException
-
- All Implemented Interfaces:
Serializable
public class ConfigurationException extends RuntimeException
Exception thrown when a required configuration value is missing or invalid.This exception is used by methods like
ConfNG.getRequired(ConfNGKey)to indicate that a mandatory configuration value could not be found in any configuration source.Example usage:
try { String dbUrl = ConfNG.getRequired(MyConfig.DATABASE_URL); } catch (ConfigurationException e) { // Handle missing required configuration System.err.println("Missing required config: " + e.getKey()); }- Since:
- 1.1.0
- Author:
- Bharat Kumar Malviya, GitHub: github.com/imBharatMalviya
- See Also:
ConfNG.getRequired(ConfNGKey), Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ConfigurationException(String key)Creates a new ConfigurationException for a missing required configuration.ConfigurationException(String key, String message)Creates a new ConfigurationException with a custom message.ConfigurationException(String key, String message, Throwable cause)Creates a new ConfigurationException with a cause.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetErrorMessage()Gets the error message.StringgetKey()Gets the configuration key that caused this exception.-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
ConfigurationException
public ConfigurationException(String key)
Creates a new ConfigurationException for a missing required configuration.- Parameters:
key- the configuration key that was missing
-
ConfigurationException
public ConfigurationException(String key, String message)
Creates a new ConfigurationException with a custom message.- Parameters:
key- the configuration keymessage- the error message
-
-