diff --git a/README.md b/README.md index 57b4656..8360405 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.cowwoc.pouch/java/badge.svg)](https://search.maven.org/search?q=g:com.github.cowwoc.pouch) [![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](http://cowwoc.github.io/pouch/4.5/docs/api/) [![Changelog](https://img.shields.io/badge/changelog-A345D5.svg)](wiki/Changelog.md) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.cowwoc.pouch/java/badge.svg)](https://search.maven.org/search?q=g:com.github.cowwoc.pouch) [![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](http://cowwoc.github.io/pouch/4.5/docs/api/) [![Changelog](https://img.shields.io/badge/changelog-A345D5.svg)](docs/Changelog.md) [![build-status](../../workflows/Build/badge.svg)](../../actions?query=workflow%3ABuild) -# pouch Pouch: Inversion of Control for the Masses +# pouch Pouch: Inversion of Control for the Masses An [Inversion of Control](http://martinfowler.com/articles/injection.html) design pattern that is: @@ -28,7 +28,7 @@ To get started, add this Maven dependency: ## Scopes -[Service Locators](wiki/Frequently_Asked_Questions.md#not-your-mothers-service-locator) are registries +[Service Locators](docs/Frequently_Asked_Questions.md#not-your-mothers-service-locator) are registries that contain one or more *values*. Values can be bound to one or more *scopes*. A scope is the context within which a value is defined. @@ -415,7 +415,7 @@ public final class TestDataSourceFactory extends ConcurrentLazyFactory - + 4.0.0 com.github.cowwoc.pouch @@ -42,9 +43,9 @@ compile - ${maven.release.version} + 9 - ${maven.release.version} + 9 ${project.build.sourceDirectory} @@ -73,9 +74,9 @@ jar - - ${maven.release.version} + + 23 1.8 public @@ -94,9 +95,9 @@ aggregate - - ${maven.release.version} + + 23 public diff --git a/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyFactory.java b/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyFactory.java index 2c4abb3..bec79a6 100644 --- a/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyFactory.java +++ b/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyFactory.java @@ -19,6 +19,13 @@ */ public abstract class ConcurrentLazyFactory implements Factory { + /** + * Creates a new instance. + */ + protected ConcurrentLazyFactory() + { + } + /** * Creates a new {@code ConcurrentLazyFactory}. * diff --git a/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyReference.java b/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyReference.java index 70ca5eb..798698e 100644 --- a/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyReference.java +++ b/core/src/main/java/com/github/cowwoc/pouch/core/ConcurrentLazyReference.java @@ -15,6 +15,13 @@ */ public abstract class ConcurrentLazyReference implements Reference { + /** + * Creates a new instance. + */ + protected ConcurrentLazyReference() + { + } + /** * Creates a new {@code ConcurrentLazyReference}. * diff --git a/core/src/main/java/com/github/cowwoc/pouch/core/LazyFactory.java b/core/src/main/java/com/github/cowwoc/pouch/core/LazyFactory.java index 4054b87..4bbf867 100644 --- a/core/src/main/java/com/github/cowwoc/pouch/core/LazyFactory.java +++ b/core/src/main/java/com/github/cowwoc/pouch/core/LazyFactory.java @@ -18,6 +18,13 @@ public abstract class LazyFactory extends AbstractLazyReference implements Factory { + /** + * Creates a new instance. + */ + protected LazyFactory() + { + } + /** * Creates a new {@code LazyFactory}. * diff --git a/core/src/main/java/com/github/cowwoc/pouch/core/LazyReference.java b/core/src/main/java/com/github/cowwoc/pouch/core/LazyReference.java index 54549cf..677e877 100644 --- a/core/src/main/java/com/github/cowwoc/pouch/core/LazyReference.java +++ b/core/src/main/java/com/github/cowwoc/pouch/core/LazyReference.java @@ -16,6 +16,13 @@ */ public abstract class LazyReference extends AbstractLazyReference { + /** + * Creates a new instance. + */ + protected LazyReference() + { + } + /** * Creates a new {@code LazyReference}. * diff --git a/core/src/main/java/com/github/cowwoc/pouch/core/WrappedCheckedException.java b/core/src/main/java/com/github/cowwoc/pouch/core/WrappedCheckedException.java index 3e7ff00..ff0bfb8 100644 --- a/core/src/main/java/com/github/cowwoc/pouch/core/WrappedCheckedException.java +++ b/core/src/main/java/com/github/cowwoc/pouch/core/WrappedCheckedException.java @@ -139,6 +139,8 @@ public interface CheckedRunnable /** * A {@link Callable} that does not throw any checked exceptions. + * + * @param the return type of the {@code call} method */ @FunctionalInterface public interface UncheckedCallable @@ -146,6 +148,7 @@ public interface UncheckedCallable /** * Runs the task. * + * @return computed result * @throws WrappedCheckedException if unable to compute a result */ V call(); diff --git a/wiki/Changelog.md b/docs/Changelog.md similarity index 100% rename from wiki/Changelog.md rename to docs/Changelog.md diff --git a/documentation/ClassGuide.vsdx b/docs/ClassGuide.vsdx similarity index 100% rename from documentation/ClassGuide.vsdx rename to docs/ClassGuide.vsdx diff --git a/wiki/Frequently_Asked_Questions.md b/docs/Frequently_Asked_Questions.md similarity index 100% rename from wiki/Frequently_Asked_Questions.md rename to docs/Frequently_Asked_Questions.md diff --git a/wiki/class-guide.png b/docs/class-guide.png similarity index 100% rename from wiki/class-guide.png rename to docs/class-guide.png diff --git a/wiki/pouch.svg b/docs/pouch.svg similarity index 100% rename from wiki/pouch.svg rename to docs/pouch.svg diff --git a/dropwizard/pom.xml b/dropwizard/pom.xml index eac042d..1c2550a 100644 --- a/dropwizard/pom.xml +++ b/dropwizard/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 com.github.cowwoc.pouch @@ -79,7 +80,7 @@ org.apache.maven.plugins maven-compiler-plugin - ${maven.release.version} + 9 true true diff --git a/jersey/pom.xml b/jersey/pom.xml index e6a5a6e..2ee0d07 100644 --- a/jersey/pom.xml +++ b/jersey/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 com.github.cowwoc.pouch @@ -85,7 +86,7 @@ org.apache.maven.plugins maven-compiler-plugin - ${maven.release.version} + 9 true true diff --git a/pom.xml b/pom.xml index 084cfcc..9b4d527 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 com.github.cowwoc.pouch root @@ -52,8 +53,6 @@ UTF-8 3.9.9 - - 21 5.11.3 @@ -200,6 +199,9 @@ jar + + 23 +