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();

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private final String	advice
private static final long	serialVersionUID Hides jdk.jpackage.internal.model.JPackageException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	ConfigException(String msg, String advice)
public	ConfigException(String msg, String advice, Throwable cause)
public	ConfigException(String msg, Throwable cause)

Method Summary

Modifier and Type	Method and Description
public static ConfigException.Builder	build(StringBundle i18n)
public static ConfigException.Builder	build(StringBundle i18n, String msgId, Object... args)
public static ConfigException.Builder	build(StringBundle i18n, Throwable t)
public String	getAdvice()

advice	back to summary
private final String advice

serialVersionUID	back to summary
private static final long serialVersionUID Hides jdk.jpackage.internal.model.JPackageException.serialVersionUID.

Constructor Detail

ConfigException	back to summary
public ConfigException(String msg, String advice)

ConfigException	back to summary
public ConfigException(String msg, String advice, Throwable cause)

ConfigException	back to summary
public ConfigException(String msg, Throwable cause)

Method Detail

build	back to summary
public static ConfigException.Builder build(StringBundle i18n)

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

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

getAdvice	back to summary
public String getAdvice()

jdk.jpackage.internal.model back to summary

public Class ConfigException.Builder

Class Inheritance

extends LocalizedExceptionBuilder<ConfigException.Builder>

java.lang.Object
jdk.jpackage.internal.util.LocalizedExceptionBuilder
jdk.jpackage.internal.model.ConfigException.Builder

Builds ConfigException instances.

Field Summary

Modifier and Type	Field and Description
private String	advice

Constructor Summary

Access	Constructor and Description
private	Builder(StringBundle i18n)

Method Summary

Modifier and Type	Method and Description
public ConfigException.Builder	advice(String adviceId, Object... args)
public ConfigException	create()
private ConfigException	create(String msg, Throwable cause)

Inherited from jdk.jpackage.internal.util.LocalizedExceptionBuilder:: buildLocalizedException cause causeAndMessage create format formatString message noformat

Field Detail

advice	back to summary
private String advice

Constructor Detail

Builder	back to summary
private Builder(StringBundle i18n)

Method Detail

advice	back to summary
public ConfigException.Builder advice(String adviceId, Object... args)

create	back to summary
public ConfigException create()

create	back to summary
private ConfigException create(String msg, Throwable cause)