Correct the javadoc warnings seen under JDK 17 (#775)

* Correct the javadoc warnings seen under JDK 17 Fixes #719 Signed-off-by: Scott M Stark <starksm64@gmail.com> --------- Signed-off-by: Scott M Stark <starksm64@gmail.com>
jakartaee · Feb 26, 2024 · d0b981c · d0b981c
1 parent d9f95b4
commit d0b981c
Show file tree

Hide file tree

Showing 44 changed files with 385 additions and 44 deletions.
diff --git a/api/src/main/java/jakarta/enterprise/context/ApplicationScoped.java b/api/src/main/java/jakarta/enterprise/context/ApplicationScoped.java
@@ -91,7 +91,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<ApplicationScoped> implements ApplicationScoped {
-
+        /** Default ApplicationScoped literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/jakarta/enterprise/context/BeforeDestroyed.java b/api/src/main/java/jakarta/enterprise/context/BeforeDestroyed.java
@@ -54,19 +54,29 @@
      * Supports inline instantiation of the {@link BeforeDestroyed} qualifier.
      */
     public final static class Literal extends AnnotationLiteral<BeforeDestroyed> implements BeforeDestroyed {
-
+        /** Default RequestScoped literal */
         public static final Literal REQUEST = of(RequestScoped.class);
+        /** Default ConversationScoped literal */
 
         public static final Literal CONVERSATION = of(ConversationScoped.class);
+        /** Default SessionScoped literal */
 
         public static final Literal SESSION = of(SessionScoped.class);
+        /** Default ApplicationScoped literal */
 
         public static final Literal APPLICATION = of(ApplicationScoped.class);
 
         private static final long serialVersionUID = 1L;
 
+        /** */
         private final Class<? extends Annotation> value;
 
+        /**
+         * Obtain the literal of the provided scope annotation
+         *
+         * @param value - the scope annotation
+         * @return a new Literal value for the provided scope annotation
+         */
         public static Literal of(Class<? extends Annotation> value) {
             return new Literal(value);
         }

diff --git a/api/src/main/java/jakarta/enterprise/context/BusyConversationException.java b/api/src/main/java/jakarta/enterprise/context/BusyConversationException.java
@@ -41,18 +41,37 @@ public class BusyConversationException extends ContextException {
 
     private static final long serialVersionUID = -3599813072560026919L;
 
+    /**
+     * default ctor
+     */
     public BusyConversationException() {
         super();
     }
 
+    /**
+     * Create exception with given message
+     *
+     * @param message - context information
+     */
     public BusyConversationException(String message) {
         super(message);
     }
 
+    /**
+     * Create exception with given cause
+     *
+     * @param cause - cause of exception
+     */
     public BusyConversationException(Throwable cause) {
         super(cause);
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param message - context information
+     * @param cause - cause of exception
+     */
     public BusyConversationException(String message, Throwable cause) {
         super(message, cause);
     }

diff --git a/api/src/main/java/jakarta/enterprise/context/ContextException.java b/api/src/main/java/jakarta/enterprise/context/ContextException.java
@@ -26,18 +26,37 @@ public class ContextException extends RuntimeException {
 
     private static final long serialVersionUID = -3599813072560026919L;
 
+    /**
+     * default ctor
+     */
     public ContextException() {
         super();
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param message - context information
+     */
     public ContextException(String message) {
         super(message);
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param cause - cause of exception
+     */
     public ContextException(Throwable cause) {
         super(cause);
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param message - context information
+     * @param cause - cause of exception
+     */
     public ContextException(String message, Throwable cause) {
         super(message, cause);
     }

diff --git a/api/src/main/java/jakarta/enterprise/context/ContextNotActiveException.java b/api/src/main/java/jakarta/enterprise/context/ContextNotActiveException.java
@@ -32,18 +32,37 @@ public class ContextNotActiveException extends ContextException {
 
     private static final long serialVersionUID = -3599813072560026919L;
 
+    /**
+     * Default ctor
+     */
     public ContextNotActiveException() {
         super();
     }
 
+    /**
+     * Create exception with given message
+     *
+     * @param message - context information
+     */
     public ContextNotActiveException(String message) {
         super(message);
     }
 
+    /**
+     * Create exception with given cause
+     *
+     * @param cause - cause of exception
+     */
     public ContextNotActiveException(Throwable cause) {
         super(cause);
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param message - context information
+     * @param cause - cause of exception
+     */
     public ContextNotActiveException(String message, Throwable cause) {
         super(message, cause);
     }

diff --git a/api/src/main/java/jakarta/enterprise/context/ConversationScoped.java b/api/src/main/java/jakarta/enterprise/context/ConversationScoped.java
@@ -151,7 +151,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<ConversationScoped> implements ConversationScoped {
-
+        /** Default ConversationScoped literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/jakarta/enterprise/context/Dependent.java b/api/src/main/java/jakarta/enterprise/context/Dependent.java
@@ -108,7 +108,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<Dependent> implements Dependent {
-
+        /** Default Dependent literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/jakarta/enterprise/context/Destroyed.java b/api/src/main/java/jakarta/enterprise/context/Destroyed.java
@@ -55,19 +55,29 @@
      * @author Martin Kouba
      */
     public final static class Literal extends AnnotationLiteral<Destroyed> implements Destroyed {
-
+        /** Default RequestScoped literal */
         public static final Literal REQUEST = of(RequestScoped.class);
+        /** Default ConversationScoped literal */
 
         public static final Literal CONVERSATION = of(ConversationScoped.class);
+        /** Default SessionScoped literal */
 
         public static final Literal SESSION = of(SessionScoped.class);
+        /** Default ApplicationScoped literal */
 
         public static final Literal APPLICATION = of(ApplicationScoped.class);
 
         private static final long serialVersionUID = 1L;
 
+        /** */
         private final Class<? extends Annotation> value;
 
+        /**
+         * Obtain the literal of the provided scope annotation
+         *
+         * @param value - the scope annotation
+         * @return a new Literal value for the provided scope annotation
+         */
         public static Literal of(Class<? extends Annotation> value) {
             return new Literal(value);
         }

diff --git a/api/src/main/java/jakarta/enterprise/context/Initialized.java b/api/src/main/java/jakarta/enterprise/context/Initialized.java
@@ -55,19 +55,29 @@
      * @author Martin Kouba
      */
     public final static class Literal extends AnnotationLiteral<Initialized> implements Initialized {
-
+        /** Default RequestScoped literal */
         public static final Literal REQUEST = of(RequestScoped.class);
+        /** Default ConversationScoped literal */
 
         public static final Literal CONVERSATION = of(ConversationScoped.class);
+        /** Default SessionScoped literal */
 
         public static final Literal SESSION = of(SessionScoped.class);
+        /** Default ApplicationScoped literal */
 
         public static final Literal APPLICATION = of(ApplicationScoped.class);
 
         private static final long serialVersionUID = 1L;
 
+        /** */
         private final Class<? extends Annotation> value;
 
+        /**
+         * Obtain the literal of the provided scope annotation
+         *
+         * @param value - the scope annotation
+         * @return a new Literal value for the provided scope annotation
+         */
         public static Literal of(Class<? extends Annotation> value) {
             return new Literal(value);
         }

diff --git a/api/src/main/java/jakarta/enterprise/context/NonexistentConversationException.java b/api/src/main/java/jakarta/enterprise/context/NonexistentConversationException.java
@@ -38,18 +38,37 @@ public class NonexistentConversationException extends ContextException {
 
     private static final long serialVersionUID = -3599813072560026919L;
 
+    /**
+     * Default ctor
+     */
     public NonexistentConversationException() {
         super();
     }
 
+    /**
+     * Create exception with given message
+     *
+     * @param message - context information
+     */
     public NonexistentConversationException(String message) {
         super(message);
     }
 
+    /**
+     * Create exception with given cause
+     *
+     * @param cause - cause of exception
+     */
     public NonexistentConversationException(Throwable cause) {
         super(cause);
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param message - context information
+     * @param cause - cause of exception
+     */
     public NonexistentConversationException(String message, Throwable cause) {
         super(message, cause);
     }

diff --git a/api/src/main/java/jakarta/enterprise/context/RequestScoped.java b/api/src/main/java/jakarta/enterprise/context/RequestScoped.java
@@ -95,7 +95,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<RequestScoped> implements RequestScoped {
-
+        /** Default RequestScope literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/jakarta/enterprise/context/SessionScoped.java b/api/src/main/java/jakarta/enterprise/context/SessionScoped.java
@@ -87,7 +87,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<SessionScoped> implements SessionScoped {
-
+        /** Default SessionScoped literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/jakarta/enterprise/event/NotificationOptions.java b/api/src/main/java/jakarta/enterprise/event/NotificationOptions.java
@@ -72,10 +72,28 @@ static Builder builder() {
      */
     interface Builder {
 
+        /**
+         * Set the notification executor
+         *
+         * @param executor - {@linkplain Executor}
+         * @return this
+         */
         Builder setExecutor(Executor executor);
 
+        /**
+         * Set an option value
+         *
+         * @param optionName - name
+         * @param optionValue - value
+         * @return this
+         */
         Builder set(String optionName, Object optionValue);
 
+        /**
+         * Build the notification options
+         *
+         * @return NotificationOptions
+         */
         NotificationOptions build();
 
     }

diff --git a/api/src/main/java/jakarta/enterprise/event/ObserverException.java b/api/src/main/java/jakarta/enterprise/event/ObserverException.java
@@ -26,18 +26,37 @@ public class ObserverException extends RuntimeException {
 
     private static final long serialVersionUID = -801836224808304381L;
 
+    /**
+     * Default ctor
+     */
     public ObserverException() {
 
     }
 
+    /**
+     * Create exception with given message
+     *
+     * @param message - context information
+     */
     public ObserverException(String message) {
         super(message);
     }
 
+    /**
+     * Create exception with given cause
+     *
+     * @param cause - cause of exception
+     */
     public ObserverException(Throwable cause) {
         super(cause);
     }
 
+    /**
+     * Create exception with given message and cause
+     *
+     * @param message - context information
+     * @param cause - cause of exception
+     */
     public ObserverException(String message, Throwable cause) {
         super(message, cause);
     }

diff --git a/api/src/main/java/jakarta/enterprise/inject/Alternative.java b/api/src/main/java/jakarta/enterprise/inject/Alternative.java
@@ -71,7 +71,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<Alternative> implements Alternative {
-
+        /** Default Alternative literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;