Skip to content

Commit

Permalink
* Fixed Javadoc warnings.
Browse files Browse the repository at this point in the history
* Moved files from /wiki and /documentation into /docs.
  • Loading branch information
cowwoc committed Oct 30, 2024
1 parent 6e61353 commit c46688e
Show file tree
Hide file tree
Showing 15 changed files with 55 additions and 19 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

# <img alt="pouch" src="wiki/pouch.svg" width="128" height="146"/> Pouch: Inversion of Control for the Masses
# <img alt="pouch" src="docs/pouch.svg" width="128" height="146"/> Pouch: Inversion of Control for the Masses

An [Inversion of Control](http://martinfowler.com/articles/injection.html) design pattern that is:

Expand All @@ -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.
Expand Down Expand Up @@ -415,7 +415,7 @@ public final class TestDataSourceFactory extends ConcurrentLazyFactory<DataSourc
### Scopes that Return Different Values Over Their Lifetime

Scopes that need to return different values over their lifetime can return
a [Builder](https://en.wikipedia.org/wiki/Builder_pattern)
a [Builder](https://en.wikipedia.org/docs/Builder_pattern)
or [Supplier](https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html) that will, in turn,
return different values on every invocation.

Expand Down Expand Up @@ -601,7 +601,7 @@ The [jersey plugin](jersey/src) contains a working example. Download a copy and

# Class guide

![class-guide.png](wiki/class-guide.png)
![class-guide.png](docs/class-guide.png)

# Plugin modules

Expand Down
15 changes: 8 additions & 7 deletions core/pom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.github.cowwoc.pouch</groupId>
Expand Down Expand Up @@ -42,9 +43,9 @@
<goal>compile</goal>
</goals>
<configuration>
<release>${maven.release.version}</release>
<release>9</release>
<jdkToolchain>
<version>${maven.release.version}</version>
<version>9</version>
</jdkToolchain>
<compileSourceRoots>
<compileSourceRoot>${project.build.sourceDirectory}</compileSourceRoot>
Expand Down Expand Up @@ -73,9 +74,9 @@
<goal>jar</goal>
</goals>
<configuration>
<!-- WARNING: Must use a newer JDK to avoid https://bugs.openjdk.java.net/browse/JDK-8208269 -->
<jdkToolchain>
<version>${maven.release.version}</version>
<!-- WARNING: Must use a newer JDK to avoid https://bugs.openjdk.java.net/browse/JDK-8208269 -->
<version>23</version>
</jdkToolchain>
<source>1.8</source>
<show>public</show>
Expand All @@ -94,9 +95,9 @@
<goal>aggregate</goal>
</goals>
<configuration>
<!-- WARNING: Must use a newer JDK to avoid https://bugs.openjdk.java.net/browse/JDK-8208269 -->
<jdkToolchain>
<version>${maven.release.version}</version>
<!-- WARNING: Must use a newer JDK to avoid https://bugs.openjdk.java.net/browse/JDK-8208269 -->
<version>23</version>
</jdkToolchain>
<show>public</show>
<additionalOptions>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@
*/
public abstract class ConcurrentLazyFactory<T> implements Factory<T>
{
/**
* Creates a new instance.
*/
protected ConcurrentLazyFactory()
{
}

/**
* Creates a new {@code ConcurrentLazyFactory}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@
*/
public abstract class ConcurrentLazyReference<T> implements Reference<T>
{
/**
* Creates a new instance.
*/
protected ConcurrentLazyReference()
{
}

/**
* Creates a new {@code ConcurrentLazyReference}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@
public abstract class LazyFactory<T> extends AbstractLazyReference<T>
implements Factory<T>
{
/**
* Creates a new instance.
*/
protected LazyFactory()
{
}

/**
* Creates a new {@code LazyFactory}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@
*/
public abstract class LazyReference<T> extends AbstractLazyReference<T>
{
/**
* Creates a new instance.
*/
protected LazyReference()
{
}

/**
* Creates a new {@code LazyReference}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,13 +139,16 @@ public interface CheckedRunnable

/**
* A {@link Callable} that does not throw any checked exceptions.
*
* @param <V> the return type of the {@code call} method
*/
@FunctionalInterface
public interface UncheckedCallable<V>
{
/**
* Runs the task.
*
* @return computed result
* @throws WrappedCheckedException if unable to compute a result
*/
V call();
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
5 changes: 3 additions & 2 deletions dropwizard/pom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.github.cowwoc.pouch</groupId>
Expand Down Expand Up @@ -79,7 +80,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<release>${maven.release.version}</release>
<release>9</release>
<showDeprecation>true</showDeprecation>
<showWarnings>true</showWarnings>
<compilerArgs>
Expand Down
5 changes: 3 additions & 2 deletions jersey/pom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.github.cowwoc.pouch</groupId>
Expand Down Expand Up @@ -85,7 +86,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<release>${maven.release.version}</release>
<release>9</release>
<showDeprecation>true</showDeprecation>
<showWarnings>true</showWarnings>
<compilerArgs>
Expand Down
8 changes: 5 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.github.cowwoc.pouch</groupId>
<artifactId>root</artifactId>
Expand Down Expand Up @@ -52,8 +53,6 @@
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.version>3.9.9</maven.version>
<!-- Latest LTS version -->
<maven.release.version>21</maven.release.version>
<junit.version>5.11.3</junit.version>
</properties>

Expand Down Expand Up @@ -200,6 +199,9 @@
<goals>
<goal>jar</goal>
</goals>
<configuration>
<javadocVersion>23</javadocVersion>
</configuration>
</execution>
</executions>
</plugin>
Expand Down

0 comments on commit c46688e

Please sign in to comment.