This is an automated email from the ASF dual-hosted git repository.
jonathanhurley pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ambari.git
The following commit(s) were added to refs/heads/trunk by this push:
new 9183c07 [AMBARI-24828] Correct Javadoc Errors in the SPI (#2515)
9183c07 is described below
commit 9183c07cedecccebd940725b504715f4fd5b745d
Author: Jonathan Hurley <jonathanhur...@apache.org>
AuthorDate: Fri Oct 26 10:20:44 2018 -0400
[AMBARI-24828] Correct Javadoc Errors in the SPI (#2515)
---
.../org/apache/ambari/annotations/UpgradeCheckInfo.java | 13 +++++++------
.../main/java/org/apache/ambari/spi/RepositoryVersion.java | 2 +-
.../org/apache/ambari/spi/upgrade/CheckQualification.java | 6 +++++-
.../apache/ambari/spi/upgrade/UpgradeCheckDescription.java | 2 +-
.../org/apache/ambari/spi/upgrade/UpgradeCheckGroup.java | 2 +-
.../org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java | 7 ++++---
.../org/apache/ambari/spi/upgrade/UpgradeCheckResult.java | 4 ++--
7 files changed, 21 insertions(+), 15 deletions(-)
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java
b/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java
index d72e1a0..47880df 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java
@@ -24,18 +24,19 @@ import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.apache.ambari.spi.RepositoryType;
+import org.apache.ambari.spi.upgrade.UpgradeCheck;
import org.apache.ambari.spi.upgrade.UpgradeCheckGroup;
import org.apache.ambari.spi.upgrade.UpgradeType;
import com.google.inject.Singleton;
/**
- * The {@link UpgradeCheckInfo} annotation is used to provide ordering and
grouping
- * to any {@link ClusterCheck} instance.
- * <p/>
+ * The {@link UpgradeCheckInfo} annotation is used to provide ordering and
+ * grouping to any {@link UpgradeCheck} instance.
+ * <p>
* Classes marked with this annotation should also be {@link Singleton}. They
* will be discovered on the classpath and then registered with the
- * {@link UpgradeCheckRegistry}.
+ * {@code UpgradeCheckRegistry}.
*/
@Target({ ElementType.TYPE })
@Retention(RUNTIME)
@@ -50,7 +51,7 @@ public @interface UpgradeCheckInfo {
/**
* The order of the pre-upgrade check within its group.
- * <p/>
+ * <p>
* The order is determined by a {@code float} so that new checks can be added
* in between others without the need to reorder all of the existing checks.
*
@@ -62,7 +63,7 @@ public @interface UpgradeCheckInfo {
* Gets the upgrade types for which an upgrade check is required. By default,
* a pre-upgrade check needs to be declared in the upgrade pack. This flag
* will override that setting.
- * <p/>
+ * <p>
* Leaving this blank assumes that the check is not required.
*
* @return the upgrade types which do not need the check to be explicitely
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/RepositoryVersion.java
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/RepositoryVersion.java
index a179e26..d217237 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/RepositoryVersion.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/RepositoryVersion.java
@@ -49,7 +49,7 @@ public class RepositoryVersion {
/**
* Gets the internal ID of the repository version stored in Ambari's
database.
*
- * @return
+ * @return the internal ID of the repository, such as {code 51L}.
*/
public long getId() {
return m_id;
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java
index 870868a..41fe65c 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java
@@ -31,8 +31,12 @@ public interface CheckQualification {
* therefore be run before the upgrade.
*
* @param request
- * @return
+ * the upgrade check request.
+ * @return {@code true} if the upgrade check is applicable to the specific
+ * upgrade request, or {@code false} otherwise.
* @throws AmbariException
+ * if there was an error attempting to determine if the upgrade
+ * check is applicable to the desired upgrade.
*/
boolean isApplicable(UpgradeCheckRequest request) throws AmbariException;
}
\ No newline at end of file
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckDescription.java
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckDescription.java
index d4190e4..470e8fb 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckDescription.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckDescription.java
@@ -88,7 +88,7 @@ public class UpgradeCheckDescription {
/**
* Gets all of the registered check descriptions.
*
- * @return
+ * @return all of the registered {@link UpgradeCheckDescription} instances.
*/
public Set<UpgradeCheckDescription> values() {
return s_values;
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckGroup.java
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckGroup.java
index 56ca7cd..e79d6c4 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckGroup.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckGroup.java
@@ -20,7 +20,7 @@ package org.apache.ambari.spi.upgrade;
/**
* The {@link UpgradeCheckGroup} enum is used to organize pre-upgrade checks
* into specific groups that have their own relational ordering.
- * <p/>
+ * <p>
* The order for each group is determined by a {@code float} so that new groups
* can be added in between others without the need to reorder all of the
groups.
*/
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java
index 4836a4b..62e7673 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java
@@ -41,13 +41,14 @@ public class UpgradeCheckRequest {
/**
* Constructor.
*
- * @param clusterName
- * the name of the cluster.
+ * @param clusterInformation
+ * the name of a cluster along with its hosts, services, and
+ * topology.
* @param upgradeType
* the type of the upgrade.
* @param targetRepositoryVersion
* the target repository version for the upgrade.
- * @param configurations
+ * @param checkConfigurations
* any configurations specified in the upgrade pack which can be
used
* to when
*/
diff --git
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckResult.java
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckResult.java
index f123bab..5696745 100644
---
a/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckResult.java
+++
b/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckResult.java
@@ -54,9 +54,9 @@ public class UpgradeCheckResult {
}
/**
- * The associated {@link UpgradeCheckDescription}.
+ * The associated {@link UpgradeCheckDescription}'s text.
*
- * @return
+ * @return the desccription for the upgrade check which provided this result.
*/
public String getDescription() {
return m_upgradeCheck.getCheckDescription().getText();
