You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@slider.apache.org by st...@apache.org on 2014/12/18 22:32:29 UTC
[21/50] incubator-slider git commit: SLIDER-671 clean up a lot of the
javadoc warnings the release process complained of
SLIDER-671 clean up a lot of the javadoc warnings the release process complained of
Project: http://git-wip-us.apache.org/repos/asf/incubator-slider/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-slider/commit/270ddc23
Tree: http://git-wip-us.apache.org/repos/asf/incubator-slider/tree/270ddc23
Diff: http://git-wip-us.apache.org/repos/asf/incubator-slider/diff/270ddc23
Branch: refs/heads/feature/SLIDER-151_REST_API
Commit: 270ddc2334f08a922899032d726e1a1a90db26ab
Parents: 09d6449
Author: Steve Loughran <st...@apache.org>
Authored: Fri Dec 5 15:22:50 2014 +0000
Committer: Steve Loughran <st...@apache.org>
Committed: Fri Dec 5 15:22:50 2014 +0000
----------------------------------------------------------------------
.../apache/slider/api/ClusterDescription.java | 14 ++++----
.../java/org/apache/slider/api/ClusterNode.java | 2 +-
.../org/apache/slider/api/ResourceKeys.java | 2 +-
.../org/apache/slider/client/SliderClient.java | 5 +--
.../apache/slider/client/SliderClientAPI.java | 5 +--
.../slider/client/SliderClusterOperations.java | 1 -
.../slider/common/tools/CoreFileSystem.java | 11 +++---
.../apache/slider/common/tools/SliderUtils.java | 6 ++--
.../slider/core/build/InstanceBuilder.java | 1 -
.../slider/core/launch/AbstractLauncher.java | 4 +--
.../slider/core/launch/AppMasterLauncher.java | 4 +--
.../slider/core/main/ServiceLauncher.java | 2 +-
.../slider/core/persist/JsonSerDeser.java | 4 +--
.../core/registry/docstore/ConfigFormat.java | 2 +-
.../docstore/PublishedConfiguration.java | 4 +--
.../PublishedConfigurationOutputter.java | 2 +-
.../registry/docstore/PublishedExports.java | 6 ++--
.../docstore/PublishedExportsOutputter.java | 2 +-
.../core/registry/retrieve/AMWebClient.java | 2 +-
.../apache/slider/core/zk/ZKIntegration.java | 9 +++--
.../slider/providers/ProviderService.java | 3 +-
.../apache/slider/providers/ProviderUtils.java | 2 +-
.../providers/agent/AgentProviderService.java | 38 ++++++++++----------
.../LaunchedWorkflowCompositeService.java | 2 +-
24 files changed, 62 insertions(+), 71 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/api/ClusterDescription.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/api/ClusterDescription.java b/slider-core/src/main/java/org/apache/slider/api/ClusterDescription.java
index d875d66..3b0fd2b 100644
--- a/slider-core/src/main/java/org/apache/slider/api/ClusterDescription.java
+++ b/slider-core/src/main/java/org/apache/slider/api/ClusterDescription.java
@@ -267,7 +267,7 @@ public class ClusterDescription implements Cloneable {
public void save(File file) throws IOException {
log.debug("Saving to {}", file.getAbsolutePath());
if (!file.getParentFile().mkdirs()) {
- log.warn("Failed to mkdirs for " + file.getParentFile());
+ log.warn("Failed to mkdirs for {}", file.getParentFile());
}
DataOutputStream dataOutputStream = new DataOutputStream(new FileOutputStream(file));
writeJsonAsBytes(dataOutputStream);
@@ -365,7 +365,7 @@ public class ClusterDescription implements Cloneable {
try {
return mapper.readValue(is, ClusterDescription.class);
} catch (IOException e) {
- log.error("Exception while parsing input stream : " + e, e);
+ log.error("Exception while parsing input stream : {}", e, e);
throw e;
}
}
@@ -431,9 +431,9 @@ public class ClusterDescription implements Cloneable {
/**
* Get a cluster option or value
*
- * @param key
- * @param defVal
- * @return
+ * @param key option key
+ * @param defVal option val
+ * @return resolved value or default
*/
public String getOption(String key, String defVal) {
String val = options.get(key);
@@ -443,7 +443,7 @@ public class ClusterDescription implements Cloneable {
/**
* Get a cluster option or value
*
- * @param key
+ * @param key mandatory key
* @return the value
* @throws BadConfigException if the option is missing
*/
@@ -471,7 +471,7 @@ public class ClusterDescription implements Cloneable {
/**
* Verify that an option is set: that is defined AND non-empty
- * @param key
+ * @param key key to verify
* @throws BadConfigException
*/
public void verifyOptionSet(String key) throws BadConfigException {
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/api/ClusterNode.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/api/ClusterNode.java b/slider-core/src/main/java/org/apache/slider/api/ClusterNode.java
index 94371eb..cdfff35 100644
--- a/slider-core/src/main/java/org/apache/slider/api/ClusterNode.java
+++ b/slider-core/src/main/java/org/apache/slider/api/ClusterNode.java
@@ -171,7 +171,7 @@ public class ClusterNode {
/**
* Build from a protobuf response
* @param message
- * @return
+ * @return the deserialized node
*/
public static ClusterNode fromProtobuf(Messages.RoleInstanceState message) {
ClusterNode node = new ClusterNode();
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/api/ResourceKeys.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/api/ResourceKeys.java b/slider-core/src/main/java/org/apache/slider/api/ResourceKeys.java
index 538189a..f3eb963 100644
--- a/slider-core/src/main/java/org/apache/slider/api/ResourceKeys.java
+++ b/slider-core/src/main/java/org/apache/slider/api/ResourceKeys.java
@@ -76,7 +76,7 @@ public interface ResourceKeys {
*/
String YARN_LABEL_EXPRESSION = "yarn.label.expression";
- /** {@value} */
+ /** default label expression: */
String DEF_YARN_LABEL_EXPRESSION = null;
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/client/SliderClient.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/client/SliderClient.java b/slider-core/src/main/java/org/apache/slider/client/SliderClient.java
index 4a3cb4e..4c7640d 100644
--- a/slider-core/src/main/java/org/apache/slider/client/SliderClient.java
+++ b/slider-core/src/main/java/org/apache/slider/client/SliderClient.java
@@ -2548,8 +2548,9 @@ public class SliderClient extends AbstractSliderLaunchedService implements RunSe
}
/**
- * The configuration used for deployment (after resolution)
- * @return
+ * The configuration used for deployment (after resolution).
+ * Non-null only after the client has launched the application
+ * @return the resolved configuration or null
*/
@VisibleForTesting
public AggregateConf getLaunchedInstanceDefinition() {
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/client/SliderClientAPI.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/client/SliderClientAPI.java b/slider-core/src/main/java/org/apache/slider/client/SliderClientAPI.java
index 61948e3..40b71a0 100644
--- a/slider-core/src/main/java/org/apache/slider/client/SliderClientAPI.java
+++ b/slider-core/src/main/java/org/apache/slider/client/SliderClientAPI.java
@@ -238,10 +238,7 @@ public interface SliderClientAPI extends Service {
/**
* diagnostic operation
*
- * @param clusterName
- * application name
- * @param diagosticArgs
- * diagnostic Arguments
+ * @param diagosticArgs diagnostic Arguments
* @return 0 for success, -1 for some issues that aren't errors, just
* failures to retrieve information (e.g. no application name
* specified)
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/client/SliderClusterOperations.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/client/SliderClusterOperations.java b/slider-core/src/main/java/org/apache/slider/client/SliderClusterOperations.java
index fe44f22..e99897c 100644
--- a/slider-core/src/main/java/org/apache/slider/client/SliderClusterOperations.java
+++ b/slider-core/src/main/java/org/apache/slider/client/SliderClusterOperations.java
@@ -232,7 +232,6 @@ public class SliderClusterOperations {
/**
* Wait for an instance of a named role to be live (or past it in the lifecycle)
- * @param clustername cluster
* @param role role to look for
* @param timeout time to wait
* @return the state. If still in CREATED, the cluster didn't come up
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/common/tools/CoreFileSystem.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/common/tools/CoreFileSystem.java b/slider-core/src/main/java/org/apache/slider/common/tools/CoreFileSystem.java
index fed0bc2..3a26a1a 100644
--- a/slider-core/src/main/java/org/apache/slider/common/tools/CoreFileSystem.java
+++ b/slider-core/src/main/java/org/apache/slider/common/tools/CoreFileSystem.java
@@ -262,14 +262,12 @@ public class CoreFileSystem {
*
* @param clustername name of the cluster
* @param clusterDirectory actual directory to look for
- * @return the path to the cluster directory
- * @throws IOException trouble with FS
+ * @throws IOException trouble with FS
* @throws SliderException If the directory exists
*/
public void verifyClusterDirectoryNonexistent(String clustername,
- Path clusterDirectory) throws
- IOException,
- SliderException {
+ Path clusterDirectory)
+ throws IOException, SliderException {
if (fileSystem.exists(clusterDirectory)) {
throw new SliderException(SliderExitCodes.EXIT_INSTANCE_EXISTS,
ErrorStrings.PRINTF_E_INSTANCE_ALREADY_EXISTS, clustername,
@@ -412,7 +410,8 @@ public class CoreFileSystem {
/**
* Get the base path
*
- * @return the base path optionally configured by {@value SliderXmlConfKeys#KEY_SLIDER_BASE_PATH}
+ * @return the base path optionally configured by
+ * {@link SliderXmlConfKeys#KEY_SLIDER_BASE_PATH}
*/
public Path getBaseApplicationPath() {
String configuredBasePath = configuration.get(SliderXmlConfKeys.KEY_SLIDER_BASE_PATH);
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/common/tools/SliderUtils.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/common/tools/SliderUtils.java b/slider-core/src/main/java/org/apache/slider/common/tools/SliderUtils.java
index c260728..af034b1 100644
--- a/slider-core/src/main/java/org/apache/slider/common/tools/SliderUtils.java
+++ b/slider-core/src/main/java/org/apache/slider/common/tools/SliderUtils.java
@@ -1597,9 +1597,9 @@ public final class SliderUtils {
/**
* Truncate the given string to a maximum length provided
* with a pad (...) added to the end if expected size if more than 10.
- * @param toTruncate
- * @param maxSize
- * @return
+ * @param toTruncate string to truncate; may be null
+ * @param maxSize maximum size
+ * @return the truncated/padded string.
*/
public static String truncate(String toTruncate, int maxSize) {
if (toTruncate == null || maxSize < 1
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/build/InstanceBuilder.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/build/InstanceBuilder.java b/slider-core/src/main/java/org/apache/slider/core/build/InstanceBuilder.java
index cee2663..6812613 100644
--- a/slider-core/src/main/java/org/apache/slider/core/build/InstanceBuilder.java
+++ b/slider-core/src/main/java/org/apache/slider/core/build/InstanceBuilder.java
@@ -247,7 +247,6 @@ public class InstanceBuilder {
* @throws IOException
* @throws SliderException
* @throws LockAcquireFailedException
- * @param appconfdir dir to persist the conf to
*/
public void persist(Path appconfdir, boolean overwrite) throws
IOException,
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/launch/AbstractLauncher.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/launch/AbstractLauncher.java b/slider-core/src/main/java/org/apache/slider/core/launch/AbstractLauncher.java
index f1f5704..3051c0b 100644
--- a/slider-core/src/main/java/org/apache/slider/core/launch/AbstractLauncher.java
+++ b/slider-core/src/main/java/org/apache/slider/core/launch/AbstractLauncher.java
@@ -394,8 +394,8 @@ public abstract class AbstractLauncher extends Configured {
/**
* Return the label expression and if not set null
- * @param map
- * @return
+ * @param map map to look up
+ * @return extracted label or null
*/
public String extractLabelExpression(Map<String, String> map) {
if (map != null) {
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/launch/AppMasterLauncher.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/launch/AppMasterLauncher.java b/slider-core/src/main/java/org/apache/slider/core/launch/AppMasterLauncher.java
index 63c2abe..740badd 100644
--- a/slider-core/src/main/java/org/apache/slider/core/launch/AppMasterLauncher.java
+++ b/slider-core/src/main/java/org/apache/slider/core/launch/AppMasterLauncher.java
@@ -68,12 +68,10 @@ public class AppMasterLauncher extends AbstractLauncher {
/**
* Build the AM Launcher
* @param name app name
- * @param type applicatin type
+ * @param type application type
* @param conf hadoop config
* @param fs filesystem binding
* @param yarnClient yarn client
- * @param secureCluster is the cluster secure?
- * -the map is not retained.
* @param secureCluster flag to indicate secure cluster
* @param options map of options. All values are extracted in this constructor only
* @param resourceGlobalOptions global options
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/main/ServiceLauncher.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/main/ServiceLauncher.java b/slider-core/src/main/java/org/apache/slider/core/main/ServiceLauncher.java
index 498a8ad..cf6d21f 100644
--- a/slider-core/src/main/java/org/apache/slider/core/main/ServiceLauncher.java
+++ b/slider-core/src/main/java/org/apache/slider/core/main/ServiceLauncher.java
@@ -348,7 +348,7 @@ public class ServiceLauncher<S extends Service>
* Exit the code.
* This is method can be overridden for testing, throwing an
* exception instead. Any subclassed method MUST raise an
- * {@link ExitUtil.ExitException} instance.
+ * <code>ExitUtil.ExitException</code> instance.
* The service launcher code assumes that after this method is invoked,
* no other code in the same method is called.
* @param exitCode code to exit
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/persist/JsonSerDeser.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/persist/JsonSerDeser.java b/slider-core/src/main/java/org/apache/slider/core/persist/JsonSerDeser.java
index 4d7d310..51aefed 100644
--- a/slider-core/src/main/java/org/apache/slider/core/persist/JsonSerDeser.java
+++ b/slider-core/src/main/java/org/apache/slider/core/persist/JsonSerDeser.java
@@ -176,8 +176,8 @@ public class JsonSerDeser<T> {
/**
* Deserialize from a byte array
* @param b
- * @return
- * @throws IOException
+ * @return the deserialized value
+ * @throws IOException parse problems
*/
public T fromBytes(byte[] b) throws IOException {
String json = new String(b, 0, b.length, UTF_8);
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/registry/docstore/ConfigFormat.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/ConfigFormat.java b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/ConfigFormat.java
index 3c80dd5..ded62f7 100644
--- a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/ConfigFormat.java
+++ b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/ConfigFormat.java
@@ -44,7 +44,7 @@ public enum ConfigFormat {
/**
* Get a matching format or null
* @param type
- * @return
+ * @return the format
*/
public static ConfigFormat resolve(String type) {
for (ConfigFormat format: values()) {
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfiguration.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfiguration.java b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfiguration.java
index 28f9d3d..e453fb1 100644
--- a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfiguration.java
+++ b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfiguration.java
@@ -90,7 +90,7 @@ public class PublishedConfiguration {
* Is the configuration empty. This means either that it has not
* been given any values, or it is stripped down copy set down over the
* wire.
- * @return
+ * @return true if it is empty
*/
public boolean isEmpty() {
return entries.isEmpty();
@@ -122,7 +122,7 @@ public class PublishedConfiguration {
/**
* Convert to Hadoop XML
- * @return
+ * @return the configuration as a Hadoop Configuratin
*/
public Configuration asConfiguration() {
Configuration conf = new Configuration(false);
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfigurationOutputter.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfigurationOutputter.java b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfigurationOutputter.java
index bf812dd..ea15f39 100644
--- a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfigurationOutputter.java
+++ b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedConfigurationOutputter.java
@@ -78,7 +78,7 @@ public abstract class PublishedConfigurationOutputter {
}
/**
* Convert to a string
- * @return
+ * @return the string form
* @throws IOException
*/
public abstract String asString() throws IOException;
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExports.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExports.java b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExports.java
index 1919bfa..bf96e8c 100644
--- a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExports.java
+++ b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExports.java
@@ -71,7 +71,7 @@ public class PublishedExports {
* Is the configuration empty. This means either that it has not been given any values, or it is stripped down copy
* set down over the wire.
*
- * @return
+ * @return true if it is empty
*/
public boolean isEmpty() {
return entries.isEmpty();
@@ -102,9 +102,9 @@ public class PublishedExports {
/**
* Return the values as json string
*
- * @return
+ * @return the JSON form
*
- * @throws IOException
+ * @throws IOException mapping problems
*/
public String asJson() throws IOException {
ObjectMapper mapper = new ObjectMapper();
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExportsOutputter.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExportsOutputter.java b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExportsOutputter.java
index b21e717..67cb094 100644
--- a/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExportsOutputter.java
+++ b/slider-core/src/main/java/org/apache/slider/core/registry/docstore/PublishedExportsOutputter.java
@@ -80,7 +80,7 @@ public abstract class PublishedExportsOutputter {
/**
* Convert to a string
*
- * @return
+ * @return the string form
* @throws IOException
*/
public abstract String asString() throws IOException;
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/registry/retrieve/AMWebClient.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/registry/retrieve/AMWebClient.java b/slider-core/src/main/java/org/apache/slider/core/registry/retrieve/AMWebClient.java
index 24b1525..072c1e1 100644
--- a/slider-core/src/main/java/org/apache/slider/core/registry/retrieve/AMWebClient.java
+++ b/slider-core/src/main/java/org/apache/slider/core/registry/retrieve/AMWebClient.java
@@ -65,7 +65,7 @@ public class AMWebClient {
/**
* Get the Jersey Client
- * @return
+ * @return the client
*/
public static Client getClient() {
return client;
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/core/zk/ZKIntegration.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/core/zk/ZKIntegration.java b/slider-core/src/main/java/org/apache/slider/core/zk/ZKIntegration.java
index 0c28229..9a9cae4 100644
--- a/slider-core/src/main/java/org/apache/slider/core/zk/ZKIntegration.java
+++ b/slider-core/src/main/java/org/apache/slider/core/zk/ZKIntegration.java
@@ -104,7 +104,7 @@ public class ZKIntegration implements Watcher, Closeable {
* @param clustername
* @param canBeReadOnly
* @param watchEventHandler
- * @return
+ * @return the new instance
* @throws IOException
*/
public static ZKIntegration newInstance(String zkConnection, String username, String clustername, boolean createClusterPath, boolean canBeReadOnly, Watcher watchEventHandler) throws IOException {
@@ -230,10 +230,9 @@ public class ZKIntegration implements Watcher, Closeable {
/**
* Recursive path create
- * @param path
- * @param data
- * @param acl
- * @param createMode
+ * @param paths path list
+ * @param acl acl list
+ * @param createMode create modes
*/
public void mkPath(List<String> paths,
List<ACL> acl,
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/providers/ProviderService.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/providers/ProviderService.java b/slider-core/src/main/java/org/apache/slider/providers/ProviderService.java
index b080ecb..dd891db 100644
--- a/slider-core/src/main/java/org/apache/slider/providers/ProviderService.java
+++ b/slider-core/src/main/java/org/apache/slider/providers/ProviderService.java
@@ -106,7 +106,6 @@ public interface ProviderService extends ProviderCore,
/**
* Load a specific XML configuration file for the provider config
* @param confDir configuration directory
- * @param siteXMLFilename provider-specific filename
* @return a configuration to be included in status
* @throws BadCommandArgumentsException
* @throws IOException
@@ -153,7 +152,7 @@ public interface ProviderService extends ProviderCore,
* value can be a URL that will create an anchor over the key text.
*
* If no anchor is needed/desired, insert the key with a null value.
- * @return
+ * @return the details
*/
Map<String, String> buildMonitorDetails(ClusterDescription clusterSpec);
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/providers/ProviderUtils.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/providers/ProviderUtils.java b/slider-core/src/main/java/org/apache/slider/providers/ProviderUtils.java
index e26105e..1f5ed63 100644
--- a/slider-core/src/main/java/org/apache/slider/providers/ProviderUtils.java
+++ b/slider-core/src/main/java/org/apache/slider/providers/ProviderUtils.java
@@ -113,7 +113,7 @@ public class ProviderUtils implements RoleKeys {
* @param tarName
* @param sliderFileSystem
* @param agentDir
- * @return
+ * @return true the location could be determined and the file added
* @throws IOException
*/
public static boolean addAgentTar(Object provider,
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/providers/agent/AgentProviderService.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/providers/agent/AgentProviderService.java b/slider-core/src/main/java/org/apache/slider/providers/agent/AgentProviderService.java
index 808b15c..65888c4 100644
--- a/slider-core/src/main/java/org/apache/slider/providers/agent/AgentProviderService.java
+++ b/slider-core/src/main/java/org/apache/slider/providers/agent/AgentProviderService.java
@@ -593,9 +593,9 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Handle registration calls from the agents
*
- * @param registration
+ * @param registration registration entry
*
- * @return
+ * @return response
*/
@Override
public RegistrationResponse handleRegistration(Register registration) {
@@ -965,12 +965,12 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Read all default configs
*
- * @param fileSystem
- * @param appDef
- * @param metainfo
- *
- * @return
+ * @param fileSystem fs
+ * @param appDef app default path
+ * @param metainfo metadata
*
+ * @return configuration maps
+ *
* @throws IOException
*/
protected Map<String, DefaultConfig> initializeDefaultConfigs(SliderFileSystem fileSystem,
@@ -1029,7 +1029,7 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Get a list of all hosts for all role/container per role
*
- * @return
+ * @return the map of role->node
*/
protected Map<String, Map<String, ClusterNode>> getRoleClusterNodeMapping() {
amState.refreshClusterStatus();
@@ -1451,9 +1451,9 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Return Component based on name
*
- * @param roleName
+ * @param roleName component name
*
- * @return
+ * @return the component entry or null for no match
*/
protected Component getApplicationComponent(String roleName) {
return getMetainfo().getApplicationComponent(roleName);
@@ -1462,9 +1462,9 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Extract script path from the application metainfo
*
- * @param roleName
+ * @param roleName component name
*
- * @return
+ * @return the script path or null for no match
*/
protected CommandScript getScriptPathFromMetainfo(String roleName) {
Component component = getApplicationComponent(roleName);
@@ -1477,9 +1477,9 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Is the role of type MASTER
*
- * @param roleName
+ * @param roleName component name
*
- * @return
+ * @return true if the role category is MASTER
*/
protected boolean isMaster(String roleName) {
Component component = getApplicationComponent(roleName);
@@ -1494,9 +1494,9 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Can the role publish configuration
*
- * @param roleName
+ * @param roleName component name
*
- * @return
+ * @return true if it can be pubished
*/
protected boolean canPublishConfig(String roleName) {
Component component = getApplicationComponent(roleName);
@@ -1509,9 +1509,9 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Checks if the role is marked auto-restart
*
- * @param roleName
+ * @param roleName component name
*
- * @return
+ * @return true if it is auto-restart
*/
protected boolean isMarkedAutoRestart(String roleName) {
Component component = getApplicationComponent(roleName);
@@ -1524,7 +1524,7 @@ public class AgentProviderService extends AbstractProviderService implements
/**
* Can any master publish config explicitly, if not a random master is used
*
- * @return
+ * @return true if the condition holds
*/
protected boolean canAnyMasterPublishConfig() {
if (canAnyMasterPublish == null) {
http://git-wip-us.apache.org/repos/asf/incubator-slider/blob/270ddc23/slider-core/src/main/java/org/apache/slider/server/services/utility/LaunchedWorkflowCompositeService.java
----------------------------------------------------------------------
diff --git a/slider-core/src/main/java/org/apache/slider/server/services/utility/LaunchedWorkflowCompositeService.java b/slider-core/src/main/java/org/apache/slider/server/services/utility/LaunchedWorkflowCompositeService.java
index e939c20..bcd1969 100644
--- a/slider-core/src/main/java/org/apache/slider/server/services/utility/LaunchedWorkflowCompositeService.java
+++ b/slider-core/src/main/java/org/apache/slider/server/services/utility/LaunchedWorkflowCompositeService.java
@@ -49,7 +49,7 @@ public class LaunchedWorkflowCompositeService extends WorkflowCompositeService
/**
* Implementation of set-ness, groovy definition of true/false for a string
* @param s
- * @return
+ * @return true iff the string is non-null and non-empty
*/
protected static boolean isUnset(String s) {
return StringUtils.isEmpty(s);