improve javadoc of [Domain]Administration.reload* regarding managed d…

…omain
wildfly-extras · Jun 29, 2016 · 72059ab · 72059ab
1 parent 664a04f
commit 72059ab
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/...src/main/java/org/wildfly/extras/creaper/core/online/operations/admin/Administration.java b/...src/main/java/org/wildfly/extras/creaper/core/online/operations/admin/Administration.java
@@ -52,13 +52,14 @@ public final boolean isReloadRequired() {
         }
     }
 
-    /** Reloads the server. In domain, reloads the entire host. */
+    /** Reloads the server. In domain, reloads the entire host, which includes restarting all its servers. */
     public final void reload() throws IOException, InterruptedException, TimeoutException {
         ops.reload();
     }
 
     /**
      * Reloads the server if required. In domain, reloads the entire host if at least one server requires reload.
+     * Reloading the host includes restarting all its servers.
      * @return if the server was in fact reloaded; in domain, if the host was reloaded
      */
     public final boolean reloadIfRequired() throws IOException, InterruptedException, TimeoutException {

diff --git a/...in/java/org/wildfly/extras/creaper/core/online/operations/admin/DomainAdministration.java b/...in/java/org/wildfly/extras/creaper/core/online/operations/admin/DomainAdministration.java
@@ -109,12 +109,18 @@ public boolean isReloadRequired(String host) throws IOException {
         return domainOps.isRestartOperationRequired(host, RestartOperation.RELOAD);
     }
 
-    /** Reloads given {@code host}. This is a variant of {@link Administration#reload()}. */
+    /**
+     * Reloads given {@code host}, which includes restarting all its servers.
+     * This is a variant of {@link Administration#reload()}.
+     */
     public void reload(String host) throws IOException, InterruptedException, TimeoutException {
         domainOps.performRestartOperation(host, RestartOperation.RELOAD);
     }
 
-    /** Reloads given {@code host} if required. This is a variant of {@link Administration#reloadIfRequired()}. */
+    /**
+     * Reloads given {@code host} if required. Reloading the host includes restarting all its servers.
+     * This is a variant of {@link Administration#reloadIfRequired()}.
+     */
     public boolean reloadIfRequired(String host) throws IOException, InterruptedException, TimeoutException {
         if (domainOps.isRestartOperationRequired(host, RestartOperation.RELOAD)) {
             reload(host);