Class ConfigException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jdk.jpackage.internal.model.ConfigException

All Implemented Interfaces:

Serializable

public class ConfigException
extends Exception

Signals that error has occurred at configuration phase.

It contains an error message and an optional advice message on how to correct the error.

The preferred way to construct instances of this class is to use build(StringBundle), or build(StringBundle, Throwable), or build(StringBundle, String, Object...) methods.

StringBundle i18n = getStringBundle(); // Some way to obtain a string bundle with localized messages

throw ConfigException.build(i18n)
        .message("error.no.name")
        .advice("error.no.name.advice")
        .create();

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigException.Builder	Builds ConfigException instances.

Constructor Summary

Constructors

Constructor	Description
ConfigException(String msg, String advice)
ConfigException(String msg, String advice, Throwable cause)
ConfigException(Throwable cause)

Method Summary

Modifier and Type	Method	Description
static ConfigException.Builder	build(StringBundle i18n)
static ConfigException.Builder	build(StringBundle i18n, String msgId, Object... args)
static ConfigException.Builder	build(StringBundle i18n, Throwable t)
String	getAdvice()
static RuntimeException	rethrowConfigException(RuntimeException ex)	Throws the cause of the given RuntimeException exception as ConfigException if the cause is of this type or re-throws the given RuntimeException exception as-is otherwise.

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

Constructor Details

ConfigException

public ConfigException(String msg,
 String advice)

ConfigException

public ConfigException(String msg,
 String advice,
 Throwable cause)

ConfigException

public ConfigException(Throwable cause)

Method Details

getAdvice

public String getAdvice()

build

public static ConfigException.Builder build(StringBundle i18n)

build

public static ConfigException.Builder build(StringBundle i18n,
 String msgId,
 Object... args)

build

public static ConfigException.Builder build(StringBundle i18n,
 Throwable t)

rethrowConfigException

public static RuntimeException rethrowConfigException(RuntimeException ex)
                                               throws ConfigException

Throws the cause of the given RuntimeException exception as ConfigException if the cause is of this type or re-throws the given RuntimeException exception as-is otherwise.

Never return a value. It always throws some exception object.

Parameters:

ex - exception to re-throw

Returns:

doesn't return value

Throws:

ConfigException