feat(api)!: Remove GenericConfiguration class

BREAKING-CHANGE: Remove `GenericConfiguration` class. Use `UntypedConfiguration` to indicate generic, untyped configuration or `NoConfiguration` to indicate no configuration options instead. To build your own typed configuration options, implement `TelestionConfiguration`. Co-authored-by: pklaschka <contact@pabloklaschka.de>
wuespace · Dec 22, 2022 · ba64cfb · ba64cfb
1 parent 9ea9374
commit ba64cfb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 19 deletions.
diff --git a/telestion-api/src/main/java/de/wuespace/telestion/api/verticle/GenericConfiguration.java b/telestion-api/src/main/java/de/wuespace/telestion/api/verticle/GenericConfiguration.java
diff --git a/telestion-api/src/main/java/de/wuespace/telestion/api/verticle/package-info.java b/telestion-api/src/main/java/de/wuespace/telestion/api/verticle/package-info.java
@@ -11,8 +11,9 @@
  * in the same class called Configuration. By inferring the generics of the
  * {@link de.wuespace.telestion.api.verticle.TelestionVerticle} with this {@code Configuration}, the loading code for
  * configurations gets reduced massively.<br/>
- * When using no {@code Configuration} it is recommended to use {@link de.wuespace.telestion.api.verticle.GenericConfiguration}
+ * When using no {@code Configuration} it is recommended to use {@link de.wuespace.telestion.api.verticle.NoConfiguration}
  * which is telling the implementation, that a configuration is not needed.
+ * If you need to use dynamic or untyped configuration parameters, use {@link de.wuespace.telestion.api.verticle.UntypedConfiguration}.
  * <p>
  * By implementing {@link de.wuespace.telestion.api.verticle.trait traits} the functionality of the
  * {@link de.wuespace.telestion.api.verticle.TelestionVerticle} can be increased even more.