Issue #24 address code review comment about build method exception type

eclipse · Oct 29, 2018 · 0733144 · 0733144
1 parent 17c83d1
commit 0733144
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 22 deletions.
diff --git a/api/src/main/java/org/eclipse/microprofile/concurrent/ManagedExecutorBuilder.java b/api/src/main/java/org/eclipse/microprofile/concurrent/ManagedExecutorBuilder.java
@@ -44,17 +44,21 @@ public interface ManagedExecutorBuilder {
      * instances.</p>
      *
      * @return new instance of <code>ManagedExecutor</code>.
-     * @throws IllegalArgumentException if a thread context type that is
-     *         configured to be {@link #cleared} or {@link #propagated} is
-     *         unavailable. Also raises IllegalArgumentException if one or
-     *         more of the same context types appear in both the
-     *         {@link #cleared} set and the {@link #propagated} set.
-     * @throws IllegalStateException if the direct or indirect
+     * @throws IllegalStateException for any of the following error conditions
+     *         <ul>
+     *         <li>if one or more of the same context types appear in both the
+     *         {@link #cleared} set and the {@link #propagated} set</li>
+     *         <li>if a thread context type that is configured to be
+     *         {@link #cleared} or {@link #propagated} is unavailable</li>
+     *         <li>if the direct or indirect
      *         {@link org.eclipse.microprofile.concurrent.spi.ThreadContextProvider#getPrerequisites prerequisites}
-     *         of a <code>ThreadContextProvider</code> are unsatisfied,
-     *         or a provider has itself as a direct or indirect prerequisite,
-     *         or if more than one provider provides the same thread context
-     *         {@link org.eclipse.microprofile.concurrent.spi.ThreadContextProvider#getThreadContextType type}.
+     *         of a <code>ThreadContextProvider</code> are unsatisfied</li>
+     *         <li>if a <code>ThreadContextProvider</code> has a direct or
+     *         indirect prerequisite on itself</li>
+     *         <li>if more than one provider provides the same thread context
+     *         {@link org.eclipse.microprofile.concurrent.spi.ThreadContextProvider#getThreadContextType type}
+     *         </li>
+     *         </ul>
      */
     ManagedExecutor build();
 

diff --git a/api/src/main/java/org/eclipse/microprofile/concurrent/ThreadContextBuilder.java b/api/src/main/java/org/eclipse/microprofile/concurrent/ThreadContextBuilder.java
@@ -43,19 +43,23 @@ public interface ThreadContextBuilder {
      * instances.</p>
      *
      * @return new instance of <code>ThreadContext</code>.
-     * @throws IllegalArgumentException if a thread context type that is
-     *         configured to be {@link #cleared} or {@link #propagated} is
-     *         unavailable. Also raises IllegalArgumentException if one or
-     *         more of the same context types appear in multiple of the
-     *         following sets:
-     *         ({@link #cleared}, {@link #propagated}, {@link #unchanged}).
-     * @throws IllegalStateException if the direct or indirect
+     * @throws IllegalStateException for any of the following error conditions
+     *         <ul>
+     *         <li>if one or more of the same context types appear in multiple
+     *         of the following sets:
+     *         ({@link #cleared}, {@link #propagated}, {@link #unchanged})</li>
+     *         <li>if a thread context type that is configured to be
+     *         {@link #cleared} or {@link #propagated} is unavailable</li>
+     *         <li>if the direct or indirect
      *         {@link org.eclipse.microprofile.concurrent.spi.ThreadContextProvider#getPrerequisites prerequisites}
-     *         of a <code>ThreadContextProvider</code> are unsatisfied,
-     *         or if a <code>ThreadContextProvider</code> has a direct or
-     *         indirect prerequisite on itself, or if more than one
-     *         <code>ThreadContextProvider</code> has the same thread context
-     *         {@link org.eclipse.microprofile.concurrent.spi.ThreadContextProvider#getThreadContextType type}.
+     *         of a <code>ThreadContextProvider</code> are unsatisfied</li>
+     *         <li>if a <code>ThreadContextProvider</code> has a direct or
+     *         indirect prerequisite on itself</li>
+     *         <li>if more than one <code>ThreadContextProvider</code> has the
+     *         same thread context
+     *         {@link org.eclipse.microprofile.concurrent.spi.ThreadContextProvider#getThreadContextType type}
+     *         </li>
+     *         </ul>
      */
     ThreadContext build();