de.jfachwert.pruefung.exception.LocalizedException.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Implementierung einiger Fachwerte nach dem WAM-Ansatz

There is a newer version: 6.0.1

/*
 * Copyright (c) 2020-2024 by Oliver Boehm
 *
 * Licensed 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.
 *
 * (c)reated 15.03.2020 by oboehm ([email protected])
 */
package de.jfachwert.pruefung.exception

import de.jfachwert.Localized
import org.apache.commons.lang3.RegExUtils
import java.util.*

/**
 * In diesem Interface sind die Gemeinsamkeiten aller XxxLocalizedException
 * zusammengefasst. Eine gemeinsame Oberklasse war leider nicht möglich, weil
 * die betroffenen Exceptions bereits von anderen Exceptions abgeleitet sind.
 *
 * Diese Kotlin-Interface ist nahezu identisch mit dem alten Java-Interface.
 * Wegen https://youtrack.jetbrains.com/issue/KT-6653 gab es Probleme mit
 * der getMessage(String)-Methode. Deswegen wurde diese Methode fuer Kotlin
 * in #getMessageKey umbenannt.
 *
 * @author oboehm
 * @since 4.0 (15.03.2020)
 */
interface LocalizedException : Localized {

    /**
     * Dies ist eine Hilfsmethode, um aus einer Message den entsprechenden
     * Schluessel zu generieren, der dann fuer den Zugriff auf das
     * [ResourceBundle] verwendet wird.
     *
     * @param message Meldung der Exception (z.B. "missing value"
     * @return Meldung als Key (z.B. "missing_values")
     */
    fun getMessageKey(message: String): String {
        return RegExUtils.replaceAll(message, " ", "_")
    }

    /**
     * Hier wird die Beschreibung im Original (meist englisch) zurueckgegeben.
     *
     * @return Original-Beschreibung
     */
    val message: String?

    /**
     * Im Gegensatz `getMessage()` wird hier die Beschreibung auf deutsch
     * zurueckgegeben, wenn die Loacale auf Deutsch steht.
     *
     * @return lokalisierte Beschreibung
     */
    fun getLocalizedMessage(): String

}