de.bund.bva.isyfact.konfiguration.common.exception.KonfigurationException Maven / Gradle / Ivy
Show all versions of isy-konfiguration Show documentation
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
* The Federal Office of Administration (Bundesverwaltungsamt, BVA)
* licenses this file to you under the Apache License, Version 2.0 (the
* License). You may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package de.bund.bva.isyfact.konfiguration.common.exception;
import de.bund.bva.isyfact.konfiguration.common.impl.NachrichtenProvider;
/**
* Technische KonfigurationException, Die verwendet wird um Konfigurationsfehler, wie der Aufruf eines nicht
* vorhandenen Konfigurationsparameters, werfen zu können.
*
*/
public abstract class KonfigurationException extends RuntimeException {
/**
* Die UID.
*/
private static final long serialVersionUID = -7645311978788423287L;
/**
* Erstellt eine neue technische unchecked KonfigurationException mit einer Ausnahme-ID für
* den Fehlertext, einem Werten für die Variablenersetzung im Fehlertext und mit dem übergebenen
* Grund.
*
* Anmerkung: Der Fehlertext von cause (dem Grund) ist nicht automatisch mit dem
* übergebenen Fehlertext verbunden.
*
* @param ausnahmeId
* Die Ausnahme-ID. Der Schlüssel, welcher verwendet wird, um einen Nachrichtentext,
* welcher als Fehler-Nachricht für die Exception verwendet wird aus einem ResourceBundle
* zu laden.
* @param parameter
* Die variablen Parameterwerte. Parameterwerte f¨r die möglichen Variablen in einer
* Fehler-Nachricht. null als Wert ist erlaubt und bedeutet, dass kein Variablen zu
* ersetzen sind.
* @param cause
* Der Grund. Throwable wird gespeichert hfür die spätere Nutzung durch die Methode
* {@link #getCause()}. null als Wert ist erlaubt und bedeutet, dass kein Grund
* existiert oder der Grund nicht bekannt ist.
*/
public KonfigurationException(String ausnahmeId, Throwable cause, String... parameter) {
super(NachrichtenProvider.getMessage(ausnahmeId, parameter), cause);
}
/**
* Erstellt eine neue technische unchecked KonfigurationException mit einer Ausnahme-ID für
* den Fehlertext und dem übergebenen Grund.
*
* Anmerkung: Der Fehlertext von cause (dem Grund) ist nicht automatisch mit dem
* übergebenen Fehlertext verbunden.
*
* @param ausnahmeId
* Die Ausnahme-ID. Der Schlüssel, welcher verwendet wird, um einen Nachrichtentext,
* welcher als Fehler-Nachricht für die Exception verwendet wird aus einem ResourceBundle
* zu laden.
* @param throwable
* Der Grund. Throwable wird gespeichert hfür die spätere Nutzung durch die Methode
* {@link #getCause()}. null als Wert ist erlaubt und bedeutet, dass kein Grund
* existiert oder der Grund nicht bekannt ist.
*/
public KonfigurationException(String ausnahmeId, Throwable throwable) {
super(NachrichtenProvider.getMessage(ausnahmeId), throwable);
}
/**
* Erstellt eine neue unchecked KonfigurationException mit einer Ausnahme-ID für den
* Fehlertext.
*
* Der Grund wird nicht initialisiert und kann später durch den Aufruf der Methode
* {@link #initCause(Throwable)} initialisiert werden.
*
* @param ausnahmeId
* Die Ausnahme-ID. Der Schlüssel, welcher verwendet wird, um einen Nachrichtentext,
* welcher als Fehler-Nachricht für die Exception verwendet wird aus einem ResourceBundle
* zu laden.
*/
public KonfigurationException(String ausnahmeId) {
super(NachrichtenProvider.getMessage(ausnahmeId));
}
/**
* Erstellt eine neue unchecked KonfigurationException mit einer Fehler-ID für den Fehlertext
* und einem Werten für die Variablenersetzung im Fehlertext. Außserdem wird, wie im Default
* Konstruktor, null als Fehlertext verwendet.
*
* Der Grund wird nicht initialisiert und kann später durch den Aufruf der Methode
* {@link #initCause(Throwable)} initialisiert werden.
*
* @param ausnahmeId
* Die Fehler-ID. Der Schlüssel, welcher verwendet wird, um einen Nachrichtentext, welcher
* als Fehler-Nachricht für die Exception verwendet wird aus einem ResourceBundle zu
* laden.
* @param parameter
* Die variablen Parameterwerte. Parameterwerte f¨r die möglichen Variablen in einer
* Fehler-Nachricht. null als Wert ist erlaubt und bedeutet, dass kein Variablen zu
* ersetzen sind.
*/
public KonfigurationException(String ausnahmeId, String... parameter) {
super(NachrichtenProvider.getMessage(ausnahmeId, parameter));
}
}