Nuclos API Festlegungen: Benennung, insert, update, delete, Id, UID, Exception, Dispatch Thread, Code Style.

Sprache: Deutsch · English

Festlegungen für Nuclos API Entwicklung

Konventionen für die Nuclos-API – Benennung von Methoden/Ids und Regeln für die Fehlerbehandlung.

Auf dieser Seite

Verbindliche Konventionen für die Entwicklung mit der Nuclos-API – für konsistenten, wartbaren Code.

Benennung

Regel	Beispiel
Collections: Suffix `...All()`	`insert(BusinessObject)` vs. `insertAll(Collection<BusinessObject>)`
Löschen: `delete`	nicht `remove`, `drop` …
Einfügen: `insert`	nicht `new`, `create` …
Aktualisieren: `update`	nicht `modify` …
Ids: `Id` statt `ID`	`getId()`, Rückgabe-Methoden enden auf `...Id()`
Id-Datentyp	immer `Long` bzw. `UID`

Exceptions nie still abfangen – mindestens eine Warnung ins Log schreiben.
Auf dem Dispatch-Thread keine RuntimeException (z.B. CommonFatalException) werfen – das bringt die GUI zum Absturz/Einfrieren.
Möglichst keine allgemeinen Exception/RuntimeException fangen; wenn nötig, so minimal wie möglich.
Lange Methodenketten vermeiden – sie sind schlecht zu debuggen und liefern nichtssagende Stacktraces.

Beispiele für sauberen Stil: Code Style sowie schlecht → richtig.