Added a note about the deadlock risk

harawata · harawata · commit fc3401bb69e9 · 2020-09-08T22:08:09.000+09:00
diff --git a/src/main/java/org/apache/ibatis/cache/decorators/BlockingCache.java b/src/main/java/org/apache/ibatis/cache/decorators/BlockingCache.java
@@ -24,12 +24,14 @@
 import org.apache.ibatis.cache.CacheException;
 
 /**
- * Simple blocking decorator
+ * <p>Simple blocking decorator
  *
- * Simple and inefficient version of EhCache's BlockingCache decorator.
+ * <p>Simple and inefficient version of EhCache's BlockingCache decorator.
  * It sets a lock over a cache key when the element is not found in cache.
  * This way, other threads will wait until this element is filled instead of hitting the database.
  *
+ * <p>By its nature, this implementation can cause deadlock when used incorrecly.
+ *
  * @author Eduardo Macarron
  *
  */

Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,14 @@`
`24`	`24`	`import org.apache.ibatis.cache.CacheException;`
`25`	`25`
`26`	`26`	`/**`
`27`		`- * Simple blocking decorator`
	`27`	`+ * <p>Simple blocking decorator`
`28`	`28`	`*`
`29`		`- * Simple and inefficient version of EhCache's BlockingCache decorator.`
	`29`	`+ * <p>Simple and inefficient version of EhCache's BlockingCache decorator.`
`30`	`30`	`* It sets a lock over a cache key when the element is not found in cache.`
`31`	`31`	`* This way, other threads will wait until this element is filled instead of hitting the database.`
`32`	`32`	`*`
	`33`	`+ * <p>By its nature, this implementation can cause deadlock when used incorrecly.`
	`34`	`+ *`
`33`	`35`	`* @author Eduardo Macarron`
`34`	`36`	`*`
`35`	`37`	`*/`