Update javadocs [skip ci]

openjax · Sep 18, 2023 · 3572516 · 3572516
1 parent 8cf21f1
commit 3572516
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/common/src/main/java/org/openjax/esc/UncaughtServletExceptionFilter.java b/common/src/main/java/org/openjax/esc/UncaughtServletExceptionFilter.java
@@ -28,10 +28,20 @@
 import javax.servlet.ServletResponse;
 import javax.servlet.annotation.WebFilter;
 
+/**
+ * A {@link Filter} intended to be used for the purpose of catching uncaught exceptions that are thrown in the servlet execution
+ * chain.
+ */
 @WebFilter(filterName="UncaughtServletExceptionFilter", urlPatterns="/*", dispatcherTypes=DispatcherType.REQUEST)
 class UncaughtServletExceptionFilter implements Filter {
   private final UncaughtServletExceptionHandler uncaughtServletExceptionHandler;
 
+  /**
+   * Creates a new {@link UncaughtServletExceptionFilter} with the provided {@link UncaughtServletExceptionHandler}.
+   *
+   * @param uncaughtServletExceptionHandler The {@link UncaughtServletExceptionHandler}.
+   * @throws NullPointerException If {@code uncaughtServletExceptionHandler} is null.
+   */
   UncaughtServletExceptionFilter(final UncaughtServletExceptionHandler uncaughtServletExceptionHandler) {
     this.uncaughtServletExceptionHandler = Objects.requireNonNull(uncaughtServletExceptionHandler);
   }