From b96de782e42d36d3da3a4c313cb8884055996756 Mon Sep 17 00:00:00 2001 From: Gili Tzabari <cowwoc2020@gmail.com> Date: Thu, 12 Dec 2024 14:40:04 -0500 Subject: [PATCH] Updated documentation --- README.md | 8 ++++---- docs/Changelog.md | 4 ++++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9de9241..80846b9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ To get started, add this Maven dependency: <dependency> <groupId>com.github.cowwoc.pouch</groupId> <artifactId>core</artifactId> - <version>5.1</version> + <version>5.2</version> </dependency> ``` @@ -138,7 +138,7 @@ For example, notice how `AbstractDatabaseScope.getRunMode()` delegates to `JvmSc When running in a multi-threaded environment, such as a web server, you might want to wait for ongoing HTTP requests to complete before shutting down the server. You can use the -[ConcurrentChildScopes](https://cowwoc.github.io/pouch/5.1/docs/api/com.github.cowwoc.pouch.core/com/github/cowwoc/pouch/core/ConcurrentChildScopes.html) +[ConcurrentChildScopes](https://cowwoc.github.io/pouch/5.2/docs/api/com.github.cowwoc.pouch.core/com/github/cowwoc/pouch/core/ConcurrentChildScopes.html) class to implement this as follows: ```java @@ -588,9 +588,9 @@ The scope approach makes it easier to look up multiple values, or pass the scope The library contains two types of classes: ones that are thread-safe and ones that are not. For example, -[ConcurrentLazyFactory](https://cowwoc.github.io/pouch/5.1/docs/api/com.github.cowwoc.pouch.core/com/github/cowwoc/pouch/core/ConcurrentLazyFactory.html) +[ConcurrentLazyFactory](https://cowwoc.github.io/pouch/5.2/docs/api/com.github.cowwoc.pouch.core/com/github/cowwoc/pouch/core/ConcurrentLazyFactory.html) is the thread-safe equivalent -of [LazyFactory](https://cowwoc.github.io/pouch/5.1/docs/api/com.github.cowwoc.pouch.core/com/github/cowwoc/pouch/core/LazyFactory.html). +of [LazyFactory](https://cowwoc.github.io/pouch/5.2/docs/api/com.github.cowwoc.pouch.core/com/github/cowwoc/pouch/core/LazyFactory.html). `LazyFactory` is faster than `ConcurrentLazyFactory`, but doesn't support access from multiple threads. Classes that are required to support multithreaded access (such as the application scope) must use the thread-safe classes. diff --git a/docs/Changelog.md b/docs/Changelog.md index c097e3c..90e5f3b 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -1,6 +1,10 @@ Minor updates involving cosmetic changes have been omitted from this list. See [commits](../../commits/master) for a full list. +## Version 5.2 - 2024/12/12 + +* Bugfix: [Fail on WrappedCheckedException validation before calling super](https://github.com/cowwoc/pouch/pull/9) by [@bkoprucu](https://github.com/bkoprucu) + ## Version 5.1 - 2024/10/31 * Javadoc fixes.