From dfeaef1355aaaf6868bc319835b35c6ef5ed9767 Mon Sep 17 00:00:00 2001 From: Cheng Pan Date: Wed, 2 Apr 2025 14:26:32 +0800 Subject: [PATCH] [MINOR] Add spec link to JavaSerializer ### What changes were proposed in this pull request? Document [Java Object Serialization Specification](https://docs.oracle.com/javase/8/docs/platform/serialization/spec/protocol.html) on `JavaSerializer` ### Why are the changes needed? To help developers who extend the `Serializer` to understand the existing `JavaSerializer` protocol. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Review. Closes #3194 from pan3793/minor-docs. Authored-by: Cheng Pan Signed-off-by: Cheng Pan --- .../org/apache/celeborn/common/serializer/JavaSerializer.scala | 3 +++ 1 file changed, 3 insertions(+) diff --git a/common/src/main/scala/org/apache/celeborn/common/serializer/JavaSerializer.scala b/common/src/main/scala/org/apache/celeborn/common/serializer/JavaSerializer.scala index 5a8e094c4..d38161583 100644 --- a/common/src/main/scala/org/apache/celeborn/common/serializer/JavaSerializer.scala +++ b/common/src/main/scala/org/apache/celeborn/common/serializer/JavaSerializer.scala @@ -136,6 +136,9 @@ private[celeborn] class JavaSerializerInstance( * @note This serializer is not guaranteed to be wire-compatible across different versions of * Spark. It is intended to be used to serialize/de-serialize data within a single * Spark application. + * + * @note Java Object Serialization Specification: + * https://docs.oracle.com/javase/8/docs/platform/serialization/spec/protocol.html */ class JavaSerializer(conf: CelebornConf) extends Serializer with Externalizable { private var counterReset = conf.getInt("spark.serializer.objectStreamReset", 100)