de.svws_nrw.asd.validate.ValidatorFehler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of svws-asd Show documentation

Diese Bibliothek stellt grundlegende Datenypen und Algorithmen für die Prüfung der amtlichen Schuldaten in NRW bereit

There is a newer version: 1.0.0

package de.svws_nrw.asd.validate;

import de.svws_nrw.transpiler.annotations.TsObject;
import jakarta.validation.constraints.NotNull;

/**
 * Diese Klasse beschreibt Fehler, welche durch Validatoren auftreten.
 *
 * @param    der Typ der zu validierenden Daten
 */
public class ValidatorFehler<@TsObject T> {

	/** Der Validator bei dem die Validierung fehlgeschlagen ist. */
	private final @NotNull Validator _validator;

    /** Die Fehlermeldung, welche vom Validator gemeldet wurde */
    private final @NotNull String _fehlermeldung;


    /**
     * Erstellt einen neuen Validierungs-Fehler
     *
     * @param validator       der Validator bei dem die Validierung fehlgeschlagen ist
     * @param fehlermeldung   die Fehlermeldung, welche vom Validator gemeldet wurde
     */
    public ValidatorFehler(final @NotNull Validator validator, final @NotNull String fehlermeldung) {
    	this._validator = validator;
    	this._fehlermeldung = fehlermeldung;
    }


    /**
     * Die Schulnummer der Schule, bei der die Validierung fehlgeschlagen ist
     *
     * @return die Schulnummer
     */
	public long getSchulnummer() {
		return _validator.kontext().getSchulnummer();
	}


	/**
	 * Gibt den Validator-Kontext zurück, bei dem der Fehler aufgetreten ist.
	 *
	 * @return der Kontext
	 */
	public @NotNull ValidatorKontext getKontext() {
		return _validator.kontext();
	}


	/**
	 * Der Validator, bei dem die Validierung fehlgeschlagen ist
	 *
	 * @return der Validator
	 */
	public Validator getValidator() {
		return _validator;
	}


	/**
	 * Der Name der Validator-Klasse, bei der die Validierung fehlgeschlagen ist
	 *
	 * @return der Name der Validator-Klasse
	 */
	public @NotNull String getValidatorClassname() {
		return _validator.getClass().getCanonicalName();
	}


	/**
	 * Die Validator-Klasse, bei der die Validierung fehlgeschlagen ist
	 *
	 * @return die Validator-Klasse
	 */
	@SuppressWarnings("unchecked")
	public Class> getValidatorClass() {
		return (Class>) _validator.getClass();
	}


	/**
	 * Das DTO, bei dem die Validierung fehlgeschlagen ist
	 *
	 * @return das DTO
	 */
	public T getDTO() {
		return _validator.daten();
	}


	/**
	 * Der Name der DTO-Klasse, bei der die Validierung fehlgeschlagen ist
	 *
	 * @return der Name der DTO-Klasse
	 */
	public String getDTOClassname() {
		return _validator.getDTOClass().getCanonicalName();
	}


	/**
	 * Die DTO-Klasse, bei der die Validierung fehlgeschlagen ist
	 *
	 * @return die DTO-Klasse
	 */
	public Class getDTOClass() {
		return _validator.getDTOClass();
	}


	/**
	 * Die Fehlermeldung, welche vom Validator erzeugt wurde
	 *
	 * @return die Fehlermeldung
	 */
	public String getFehlermeldung() {
		return _fehlermeldung;
	}

}