From 875f389e9d50b88d02993d44315eca528246d318 Mon Sep 17 00:00:00 2001
From: Vadzim Hushchanskou <vadzim_hushchanskou@epam.com>
Date: Thu, 5 Sep 2024 15:50:00 +0300
Subject: [PATCH] Add Javadocs

---
 .../karate/utils/BlockingConcurrentHashMap.java            | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/main/java/com/epam/reportportal/karate/utils/BlockingConcurrentHashMap.java b/src/main/java/com/epam/reportportal/karate/utils/BlockingConcurrentHashMap.java
index 7394261..d49290a 100644
--- a/src/main/java/com/epam/reportportal/karate/utils/BlockingConcurrentHashMap.java
+++ b/src/main/java/com/epam/reportportal/karate/utils/BlockingConcurrentHashMap.java
@@ -28,6 +28,13 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 
+/**
+ * This class ensures that {@link Map#computeIfAbsent(Object, Function)} is called only once for the same key. It has inner blocking timeout
+ * of 1 minute to wait for the value to be computed.
+ *
+ * @param <K> a key type for the map
+ * @param <V> a value type to store
+ */
 public class BlockingConcurrentHashMap<K, V> {
 	private static final Logger LOGGER = LoggerFactory.getLogger(BlockingConcurrentHashMap.class);