From 3bad7905157e4b8b36322109a243c0b251182945 Mon Sep 17 00:00:00 2001 From: Sachin Kale Date: Wed, 14 Aug 2024 15:18:48 +0530 Subject: [PATCH] Fix javadocs Signed-off-by: Sachin Kale --- .../remote/model/RemotePinnedTimestamps.java | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/server/src/main/java/org/opensearch/gateway/remote/model/RemotePinnedTimestamps.java b/server/src/main/java/org/opensearch/gateway/remote/model/RemotePinnedTimestamps.java index ede434bfa325b..b3187c1bd2ec2 100644 --- a/server/src/main/java/org/opensearch/gateway/remote/model/RemotePinnedTimestamps.java +++ b/server/src/main/java/org/opensearch/gateway/remote/model/RemotePinnedTimestamps.java @@ -38,6 +38,10 @@ public class RemotePinnedTimestamps extends RemoteWriteableBlobEntity { private static final Logger logger = LogManager.getLogger(RemotePinnedTimestamps.class); + /** + * Represents a collection of pinned timestamps and their associated pinning entities. + * This class is thread-safe and implements the Writeable interface for serialization. + */ public static class PinnedTimestamps implements Writeable { private final Map> pinnedTimestampPinningEntityMap; @@ -54,11 +58,23 @@ public static PinnedTimestamps readFrom(StreamInput in) throws IOException { return new PinnedTimestamps(in.readMap(StreamInput::readLong, StreamInput::readStringList)); } + /** + * Pins a timestamp against a pinning entity. + * + * @param timestamp The timestamp to pin. + * @param pinningEntity The entity pinning the timestamp. + */ public void pin(Long timestamp, String pinningEntity) { logger.debug("Pinning timestamp = {} against entity = {}", timestamp, pinningEntity); pinnedTimestampPinningEntityMap.computeIfAbsent(timestamp, k -> new ArrayList<>()).add(pinningEntity); } + /** + * Unpins a timestamp for a specific pinning entity. + * + * @param timestamp The timestamp to unpin. + * @param pinningEntity The entity unpinning the timestamp. + */ public void unpin(Long timestamp, String pinningEntity) { logger.debug("Unpinning timestamp = {} against entity = {}", timestamp, pinningEntity); pinnedTimestampPinningEntityMap.computeIfPresent(timestamp, (k, v) -> {