Nutzungsvorgaben Util

1. Einleitung

Die Bibliothek isy-util bietet nützliche Hilfsmittel, die von den Anwendungen der IsyFact genutzt werden können. Es handelt sich dabei um kleinere Utility-Klassen, welche die Implementierung vereinfachen. Diese werden im Folgenden überblicksartig beschrieben. Details sind den JavaDoc der einzelnen Klassen zu entnehmen.

2. Aufbau von isy-util

2.1. Common

Das Package de.bund.bva.isyfact.util.common enthält allgemeine Klassen, die keiner speziellen Funktionalität zugeordnet sind. Zurzeit besteht sie aus folgender Klasse:

  • RecursiveToStringBuilder: Diese Klasse erzeugt eine Textausgabe für Objekte, die keine geeignete toString-Methode implementieren.

2.2. Package exception

Deprecation

Dieser Teil der Dokumentation ist veraltet und wird in einem zukünftigen Release entfernt. Die Inhalte sollten zur Entwicklung neuer Anwendungen nicht mehr berücksichtigt werden. Stattdessen wird empfohlen, FehlertextProvider zu verwenden.

Anmerkung zur Deprecation

Für Fehlermeldungen wird empfohlen, das Interface de.bund.bva.isyfact.exception.FehlertextProvider zu implementieren.

In de.bund.bva.isyfact.util.exception sind Klassen enthalten, die für die Fehlerbehandlung einzusetzen sind:

  • MessageSourceFehlertextProvider: Durch diese Klasse wird der FehlertextProvider implementiert, der sich im Package de.bund.bva.isyfact.exception der Bibliothek isy-exception-core befindet. Der FehlertextProvider beschreibt Methoden zum Auslesen von Fehlertexten auf Basis von IDs der Ausnahmen und Parameter, sofern welche vorhanden sind.

2.3. Package spring

Deprecation

Dieser Teil der Dokumentation ist veraltet und wird in einem zukünftigen Release entfernt. Die Inhalte sollten zur Entwicklung neuer Anwendungen nicht mehr berücksichtigt werden. Stattdessen wird empfohlen, org.springframework.context.MessageSource zu verwenden.

Anmerkung zur Deprecation

Für die Benennung der MessageSource-Bean wird empfohlen, einen eindeutigeren Namen zu wählen, damit diese mittels Spring-Bordmitteln überschrieben werden kann.

Das Package de.bund.bva.isyfact.util.spring enthält Werkzeuge für den Umgang mit Spring:

  • MessageSourceHolder: Der MessageSourceHolder ist eine Referenz auf die aktuelle MessageSource-Bean. Zusätzlich bietet er Convenience-Funktionen zum Auslesen von ResourceBundle-Einträgen aus der MessageSource.