add javadoc for decodeSafe method (#21207)

Graylog2 · Dec 17, 2024 · b9a8df3 · b9a8df3
1 parent f197bbb
commit b9a8df3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/graylog2-server/src/main/java/org/graylog2/plugin/inputs/codecs/Codec.java b/graylog2-server/src/main/java/org/graylog2/plugin/inputs/codecs/Codec.java
@@ -28,6 +28,12 @@
 
 public interface Codec {
 
+    /**
+     * @param rawMessage
+     * @return an empty Optional if RawMessage contains payload data that should not be decoded.
+     * Otherwise, an Optional with a Message that can be processed further.
+     * @throws org.graylog2.plugin.inputs.failure.InputProcessingException if an error occurs during decoding.
+     */
     default Optional<Message> decodeSafe(@Nonnull RawMessage rawMessage) {
         return Optional.ofNullable(decode(rawMessage));
     }