de.jfachwert.KSimpleValidator.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) 2017-2023 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 20.08.17 by oliver ([email protected])
 */
package de.jfachwert

import de.jfachwert.pruefung.exception.LocalizedIllegalArgumentException
import java.io.Serializable
import java.util.logging.Level
import java.util.logging.Logger

/**
 * Um die verschiedenen Validatoren als allgemeines Attribut verwendenen
 * zu koennen, sind die Gemeinsamkeiten in diesem Interface zusammengefasst.
 *
 * Damit das Interface nicht mit dem Validator-Interface aus javax.validation
 * verwechselt wird, wurde es in SimpleValidator umbenannt.
 *
 * Urspruenglich sollte diese Version die Java-Variante ersezten. Allerdings
 * gibt es in Kotlin noch Kompatibilitaetsprobleme bei Interfaces mit
 * Default-Implementierung, sodass die Original-Java-Implementierung
 * beibehalten wurde und die Kotlin-Variante in KSimpleValidator umbenannt
 * wurde.
 *
 * @since 0.4 (20.08.17)
 */
interface KSimpleValidator : Serializable, SimpleValidator {

    /**
     * Wenn der uebergebene Wert gueltig ist, soll er unveraendert
     * zurueckgegeben werden, damit er anschliessend von der aufrufenden
     * Methode weiterverarbeitet werden kann. Ist der Wert nicht gueltig,
     * soll eine [ValidationException] geworfen
     * werden.
     *
     * @param value Wert, der validiert werden soll
     * @return Wert selber, wenn er gueltig ist
     */
    override fun validate(value: T): T

    override fun validateObject(value: Any): Any? {
        try {
            return validate(value as T)
        } catch (ex: ClassCastException) {
            logger.log(Level.FINE, "cannot cast $value", ex)
        }
        return value
    }

    /**
     * Im Unterschied zur [.validate]-Methode wird hier
     * eine [IllegalArgumentException] geworfen, wenn der Wert kein
     * gueltiges Argument ist.
     *
     * @param value Wert, der verifiziert werden soll
     * @return Wert selber, wenn er gueltig ist
     */
    override fun verify(value: T): T {
        return try {
            validate(value)
        } catch (ex: RuntimeException) {
            throw LocalizedIllegalArgumentException(ex)
        }
    }

    companion object {
        val logger = Logger.getLogger(KSimpleValidator::class.java.name)
    }

}