Package de.espirit.firstspirit.access.store.templatestore.gom

Class ConfigurationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

de.espirit.firstspirit.access.store.templatestore.gom.ConfigurationException

All Implemented Interfaces:

Serializable

public class ConfigurationException
extends RuntimeException

Thrown if a configuration is incorrect.

Since:

5.2.25

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConfigurationException(@NotNull String message, @NotNull String errorCode)	Creates a new instance with the specified message and error code

Method Summary

Modifier and Type	Method	Description
@Nullable HashMap<String,String>	getContext()	Get the defined context, if any.
@Nullable String	getDetail()	Provides a detail fragment for locating the error.
@NotNull String	getErrorCode()	Provides the FS error code.
void	putContext(@NotNull String key, @NotNull String value)	Put a context value at the given key.
void	setDetail(String detail)	Sets the detail fragment.

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

ConfigurationException

public ConfigurationException(@NotNull
 @NotNull String message,
 @NotNull
 @NotNull String errorCode)

Creates a new instance with the specified message and error code

Parameters:

message - the message of the exception

errorCode - the FS error code

Since:

5.2.25

Method Details

getErrorCode

@NotNull
public @NotNull String getErrorCode()

Provides the FS error code.

Returns:

The FS error code.

Since:

5.2.25

getDetail

@Nullable
public @Nullable String getDetail()

Provides a detail fragment for locating the error.

Returns:

A detail fragment or null.

Since:

5.2.25

setDetail

public void setDetail(String detail)

Sets the detail fragment.

Parameters:

detail - The detail fragment.

Since:

5.2.25

getContext

@Nullable
public @Nullable HashMap<String,String> getContext()

Get the defined context, if any.

Returns:

The context or null.

Since:

5.2.25

putContext

public void putContext(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

Put a context value at the given key.

Parameters:

key - The contextual key.

value - The contextual value.

Since:

5.2.25