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

import java.io.Serializable

/**
 * In diesem Interface fuer Fachwerte sind alle Eigenschaften zusammengefasst,
 * die sich in Form eines Interfaces ausdruecken lassen. Fachwerte sind:
 *
 *  * unveraenderlich (Immutable),
 *  * serialisierbar,
 *  * ...
 *
 *  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 KFachwert umbenannt wurde.
 *
 * @author [email protected]
 */
interface KFachwert : Serializable, Fachwert {

    /**
     * Liefert die einzelnen Attribute eines Fachwertes als Map. Diese Methode
     * wird fuer die Default-Serialisierung nach JSON benoetigt.
     *
     * @return Attribute als Map
     */
    override fun toMap(): Map {
        throw UnsupportedOperationException("not yet implemented")
    }

    /**
     * Normalerweise liefert diese Methode 'true' zurueck, da es nicht moeglich
     * ist, ungueltige Fachwerte zu erstellen. Allerdings kann man auch den
     * Validator gegen den {@link de.jfachwert.pruefung.NullValidator}
     * austauschen. In diesem Fall sollte diese Methode 'false' zurueck
     * liefern, wenn der Fachwert nicht gueltig ist.
     *
     * @return normalerweise true
     */
    override fun isValid(): Boolean {
        return true
    }

}