feat(api)!: Make HeaderInformation MultiMap complete and rename method get to getString.

BREAKING-CHANGE: Rename method `get` to `getString` in `HeaderInformation` class.

Co-authored-by: pklaschka <[email protected]>

Author: fussel178

telestion-api/src/main/java/de/wuespace/telestion/api/message/HeaderInformation.java

@@ -48,7 +48,7 @@
  * @author Cedric Boes (@cb0s), Ludwig Richter (@fussel178)
  * @see de.wuespace.telestion.api.verticle.trait.WithEventBus
  */
-public class HeaderInformation {
+public class HeaderInformation implements MultiMap {
 
 	///////////////////////////////////////////////////////////////////////////
 	// utilities
@@ -201,6 +201,16 @@ public DeliveryOptions toOptions() {
 	// getters
 	///////////////////////////////////////////////////////////////////////////
 
+	@Override
+	public String get(CharSequence name) {
+		return headers.get(name);
+	}
+
+	@Override
+	public String get(String name) {
+		return headers.get(name);
+	}
+
 	/**
 	 * Returns the first stored value assigned to the key as {@link String}.
 	 * If no value is assigned to the key, an {@link Optional#empty() empty Optional} is returned instead.
@@ -209,7 +219,7 @@ public DeliveryOptions toOptions() {
 	 * @return the first stored value wrapped inside an {@link Optional} for better {@code null} type safety
 	 * @see MultiMap#get(String)
 	 */
-	public Optional<String> get(String key) {
+	public Optional<String> getString(String key) {
 		return Optional.ofNullable(headers.get(key));
 	}
 
@@ -222,8 +232,8 @@ public Optional<String> get(String key) {
 	 * @return the first stored value or the default value if no value is assigned to the key
 	 * @see MultiMap#get(String)
 	 */
-	public String get(String key, String defaultValue) {
-		return get(key).orElse(defaultValue);
+	public String getString(String key, String defaultValue) {
+		return getString(key).orElse(defaultValue);
 	}
 
 	/**
@@ -235,7 +245,7 @@ public String get(String key, String defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Byte> getByte(String key) {
-		return get(key).map(safeParse(Byte::parseByte));
+		return getString(key).map(safeParse(Byte::parseByte));
 	}
 
 	/**
@@ -260,7 +270,7 @@ public byte getByte(String key, byte defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Integer> getInt(String key) {
-		return get(key).map(safeParse(Integer::parseInt));
+		return getString(key).map(safeParse(Integer::parseInt));
 	}
 
 	/**
@@ -285,7 +295,7 @@ public int getInt(String key, int defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Long> getLong(String key) {
-		return get(key).map(safeParse(Long::parseLong));
+		return getString(key).map(safeParse(Long::parseLong));
 	}
 
 	/**
@@ -310,7 +320,7 @@ public long getLong(String key, long defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Float> getFloat(String key) {
-		return get(key).map(safeParse(Float::parseFloat));
+		return getString(key).map(safeParse(Float::parseFloat));
 	}
 
 	/**
@@ -335,7 +345,7 @@ public float getFloat(String key, float defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Double> getDouble(String key) {
-		return get(key).map(safeParse(Double::parseDouble));
+		return getString(key).map(safeParse(Double::parseDouble));
 	}
 
 	/**
@@ -360,7 +370,7 @@ public double getDouble(String key, double defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Character> getChar(String key) {
-		return get(key).map(value -> value.length() == 1 ? value.charAt(0) : null);
+		return getString(key).map(value -> value.length() == 1 ? value.charAt(0) : null);
 	}
 
 	/**
@@ -385,7 +395,7 @@ public char getChar(String key, char defaultValue) {
 	 * @see MultiMap#get(String)
 	 */
 	public Optional<Boolean> getBoolean(String key) {
-		return get(key).map(Boolean::parseBoolean);
+		return getString(key).map(Boolean::parseBoolean);
 	}
 
 	/**
@@ -412,6 +422,11 @@ public List<String> getAll(String key) {
 		return headers.getAll(key);
 	}
 
+	@Override
+	public List<String> getAll(CharSequence name) {
+		return headers.getAll(name);
+	}
+
 	///////////////////////////////////////////////////////////////////////////
 	// adders
 	///////////////////////////////////////////////////////////////////////////
@@ -548,6 +563,26 @@ public HeaderInformation addAll(Map<String, String> headers) {
 		return this;
 	}
 
+	@Override
+	public MultiMap set(String name, String value) {
+		return headers.set(name, value);
+	}
+
+	@Override
+	public MultiMap set(CharSequence name, CharSequence value) {
+		return headers.set(name, value);
+	}
+
+	@Override
+	public MultiMap set(String name, Iterable<String> values) {
+		return headers.set(name, values);
+	}
+
+	@Override
+	public MultiMap set(CharSequence name, Iterable<CharSequence> values) {
+		return headers.set(name, values);
+	}
+
 	/**
 	 * Appends all values assigned to their keys from the {@link HeaderInformation} object to already existing values.
 	 * Returns a reference to {@code this} for fluent design.
@@ -728,6 +763,11 @@ public boolean contains(String key) {
 		return headers.contains(key);
 	}
 
+	@Override
+	public boolean contains(CharSequence name) {
+		return headers.contains(name);
+	}
+
 	/**
 	 * Removes all values assigned to the key.
 	 * Returns a reference to {@code this} for fluent design.
@@ -741,6 +781,11 @@ public HeaderInformation remove(String key) {
 		return this;
 	}
 
+	@Override
+	public MultiMap remove(CharSequence name) {
+		return headers.remove(name);
+	}
+
 	/**
 	 * Clears all values assigned to their keys.
 	 * Returns a reference to {@code this} for fluent design.
@@ -773,6 +818,26 @@ public Set<String> names() {
 		return headers.names();
 	}
 
+	@Override
+	public MultiMap add(String name, String value) {
+		return headers.add(name, value);
+	}
+
+	@Override
+	public MultiMap add(CharSequence name, CharSequence value) {
+		return headers.add(name, value);
+	}
+
+	@Override
+	public MultiMap add(String name, Iterable<String> values) {
+		return headers.add(name, values);
+	}
+
+	@Override
+	public MultiMap add(CharSequence name, Iterable<CharSequence> values) {
+		return headers.add(name, values);
+	}
+
 	/**
 	 * Returns {@code true}, if the wrapped {@link MultiMap Vert.x headers} have no entries.
 	 *
@@ -877,4 +942,9 @@ private static <T, R> Function<T, R> safeParse(Function<T, R> func) {
 	}
 
 	private static final Logger logger = LoggerFactory.getLogger(HeaderInformation.class);
+
+	@Override
+	public Iterator<Map.Entry<String, String>> iterator() {
+		return headers.iterator();
+	}
 }

telestion-api/src/main/java/de/wuespace/telestion/api/message/MultiMapUtils.java

@@ -16,33 +16,33 @@
 public class MultiMapUtils {
 
 	/**
-	 * Merges an array of multi-maps into one multi-map
+	 * Merges an array of multi-maps into one multimap
 	 * with the {@link MultiMap#addAll(MultiMap) addAll} function.
 	 *
 	 * @param maps multi-maps that you want to merge
-	 * @return a new multi-map with the merged content of the other multi-maps
+	 * @return a new multimap with the merged content of the other multi-maps
 	 */
 	public static MultiMap merge(MultiMap... maps) {
 		return merge(Arrays.stream(maps));
 	}
 
 	/**
-	 * Merges a list of multi-maps into one multi-map
+	 * Merges a list of multi-maps into one multimap
 	 * with the {@link MultiMap#addAll(MultiMap) addAll} function.
 	 *
 	 * @param list multi-maps that you want to merge
-	 * @return a new multi-map with the merged content of the other multi-maps
+	 * @return a new multimap with the merged content of the other multi-maps
 	 */
 	public static MultiMap merge(List<MultiMap> list) {
 		return merge(list.stream());
 	}
 
 	/**
-	 * Merges a stream of multi-maps into one multi-map
+	 * Merges a stream of multi-maps into one multimap
 	 * with the {@link MultiMap#addAll(MultiMap) addAll} function.
 	 *
 	 * @param stream a stream that contains the multi-maps that you want to merge
-	 * @return a new multi-map with the merged content of the other multi-maps
+	 * @return a new multimap with the merged content of the other multi-maps
 	 */
 	public static MultiMap merge(Stream<MultiMap> stream) {
 		var finalMap = MultiMap.caseInsensitiveMultiMap();