de.jfachwert.PruefzifferVerfahren.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-2020 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 19.03.17 by oliver ([email protected])
 */
package de.jfachwert

import de.jfachwert.pruefung.exception.PruefzifferException
import java.io.Serializable

/**
 * Viele Fachwerte wie IBAN, ISBN oder Steuernummer besitzen eine Pruefziffer,
 * die sich mithilfe dieses Interfaces ueberpruefen lassen.
 *
 * Prinzipiell kann die Pruefziffer auch ein beliebiges Zeichen sein, aber
 * meistens ist es tatsaechlich ein oder mehrere Ziffern, weswegen dieses
 * Interface nicht PruefzeichenVerfahren, sondern letztendlich
 * PruefzifferVerfahren heisst.
 *
 * @param  Typ, der vom Fachwert verwendet wird
 * @author [email protected]
 * @since 0.1.0
 */
interface PruefzifferVerfahren : KSimpleValidator {

    /**
     * Meistens ist die letzte Ziffer die Pruefziffer, die hierueber abgefragt
     * werden kann.
     *
     * @param wert Fachwert oder gekapselter Wert
     * @return meist ein Wert zwischen 0 und 9
     */
    fun getPruefziffer(wert: T): T

    /**
     * Berechnet die Pruefziffer des uebergebenen Wertes.
     *
     * @param wert Wert
     * @return errechnete Pruefziffer
     */
    fun berechnePruefziffer(wert: T): T

    /**
     * Liefert true zurueck, wenn der uebergebene Wert gueltig ist.
     *
     * @param wert Fachwert oder gekapselter Wert
     * @return true oder false
     */
    fun isValid(wert: T): Boolean {
        val pruefziffer = getPruefziffer(wert)
        return pruefziffer == berechnePruefziffer(wert)
    }

    /**
     * Validiert den uebergebenen Wert. Falls dieser nicht stimmt, sollte eine
     * ValidationException geworfen werden.
     *
     * @param value zu ueberpruefender Wert
     * @return den ueberprueften Wert (zur Weiterverarbeitung)
     */
    override fun validate(value: T): T {
        if (!isValid(value)) {
            throw PruefzifferException(value, berechnePruefziffer(value), getPruefziffer(value))
        }
        return value
    }

}