You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metron.apache.org by js...@apache.org on 2017/10/16 16:34:21 UTC
metron git commit: METRON-1237 address javadoc warnings in
metron-maas-common (dbist via james-sirota) closes apache/metron#792
Repository: metron
Updated Branches:
refs/heads/master 4f7081aa7 -> 4c908b95b
METRON-1237 address javadoc warnings in metron-maas-common (dbist via james-sirota) closes apache/metron#792
Project: http://git-wip-us.apache.org/repos/asf/metron/repo
Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/4c908b95
Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/4c908b95
Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/4c908b95
Branch: refs/heads/master
Commit: 4c908b95b86068bb412daa82f458fc1626d99050
Parents: 4f7081a
Author: dbist <ge...@gmail.com>
Authored: Mon Oct 16 09:33:53 2017 -0700
Committer: jsirota <js...@apache.org>
Committed: Mon Oct 16 09:33:53 2017 -0700
----------------------------------------------------------------------
.../java/org/apache/metron/maas/config/Endpoint.java | 2 +-
.../org/apache/metron/maas/config/MaaSConfig.java | 4 ++--
.../org/apache/metron/maas/config/ModelRequest.java | 12 ++++++------
.../metron/maas/discovery/ServiceDiscoverer.java | 15 +++++----------
.../org/apache/metron/maas/queue/QueueHandler.java | 2 +-
5 files changed, 15 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/metron/blob/4c908b95/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/Endpoint.java
----------------------------------------------------------------------
diff --git a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/Endpoint.java b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/Endpoint.java
index b865a0f..87b9a02 100644
--- a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/Endpoint.java
+++ b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/Endpoint.java
@@ -52,7 +52,7 @@ public class Endpoint {
* and functions which are used for data science as 'ds', you can alias /foo to 'enrich'
* and /bar to 'ds' by creating a map which maps the 'enrich' to 'foo' and 'ds' to 'bar'.
*
- * @return
+ * @return functions
*/
public Map<String, String> getFunctions() {
return functions;
http://git-wip-us.apache.org/repos/asf/metron/blob/4c908b95/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java
----------------------------------------------------------------------
diff --git a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java
index 6ed7c2f..2d3d611 100644
--- a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java
+++ b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java
@@ -36,7 +36,7 @@ public class MaaSConfig {
/**
* Return the zookeeper path for the discovery service. This is defaulted to /maas/service
- * @return
+ * @return serviceRoot
*/
public String getServiceRoot() {
return serviceRoot;
@@ -50,7 +50,7 @@ public class MaaSConfig {
/**
* Get the distributed queue implementation handler. By default, we use a queue in zookeeper
* as implemented by Apache Curator.
- * @return
+ * @return queue implementation handler
*/
public QueueHandler getQueue() {
return queue;
http://git-wip-us.apache.org/repos/asf/metron/blob/4c908b95/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java
----------------------------------------------------------------------
diff --git a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java
index 9ba9059..2b10851 100644
--- a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java
+++ b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java
@@ -31,7 +31,7 @@ public class ModelRequest {
/**
* The path in the model store (right now HDFS) for the directory containing model's bits.
- * @return
+ * @return path
*/
public String getPath() {
return path;
@@ -43,7 +43,7 @@ public class ModelRequest {
/**
* The action to perform
- * @return
+ * @return action
*/
public Action getAction() {
return action;
@@ -55,7 +55,7 @@ public class ModelRequest {
/**
* The name of the model
- * @return
+ * @return name
*/
public String getName() {
return name;
@@ -67,7 +67,7 @@ public class ModelRequest {
/**
* The version of the model
- * @return
+ * @return version
*/
public String getVersion() {
return version;
@@ -79,7 +79,7 @@ public class ModelRequest {
/**
* The number of instances of the model to start
- * @return
+ * @return numInstances
*/
public int getNumInstances() {
return numInstances;
@@ -91,7 +91,7 @@ public class ModelRequest {
/**
* The amount of memory for the containers holding the model in megabytes
- * @return
+ * @return memory
*/
public int getMemory() {
return memory;
http://git-wip-us.apache.org/repos/asf/metron/blob/4c908b95/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java
----------------------------------------------------------------------
diff --git a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java
index b05f161..488a2f4 100644
--- a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java
+++ b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java
@@ -17,11 +17,8 @@
*/
package org.apache.metron.maas.discovery;
-import com.google.common.base.Splitter;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
-import com.google.common.cache.CacheLoader;
-import com.google.common.collect.Iterables;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.curator.framework.CuratorFramework;
@@ -35,10 +32,8 @@ import org.apache.zookeeper.data.Stat;
import java.io.Closeable;
import java.util.*;
-import java.util.concurrent.ThreadLocalRandom;
import java.net.MalformedURLException;
import java.net.URL;
-import java.util.*;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReadWriteLock;
@@ -116,7 +111,7 @@ public class ServiceDiscoverer implements Closeable{
/**
* Get the underlying Curator ServiceDiscovery implementation.
- * @return
+ * @return serviceDiscovery
*/
public ServiceDiscovery<ModelEndpoint> getServiceDiscovery() {
return serviceDiscovery;
@@ -219,7 +214,7 @@ public class ServiceDiscoverer implements Closeable{
* Retrieve the endpoints for a given model. A model may or may not have a version associated with it.
* If the version is missing, then all endpoints are returned associated with that model name.
* @param model
- * @return
+ * @return endpoints for a given model
*/
public List<ModelEndpoint> getEndpoints(Model model) {
rwLock.readLock().lock();
@@ -281,7 +276,7 @@ public class ServiceDiscoverer implements Closeable{
* This will retrieve one endpoint at random for a given model.
* @param modelName
* @param modelVersion can be null
- * @return
+ * @return ModelEndpoint
*/
public ModelEndpoint getEndpoint(String modelName, String modelVersion) {
return getEndpoint(new Model(modelName, modelVersion));
@@ -290,7 +285,7 @@ public class ServiceDiscoverer implements Closeable{
/**
* Retrieve an endpoint at random of a given model
* @param model
- * @return
+ * @return ModelEndpoint
*/
public ModelEndpoint getEndpoint(Model model) {
rwLock.readLock().lock();
@@ -329,7 +324,7 @@ public class ServiceDiscoverer implements Closeable{
* List all endpoints for a given model.
*
* @param model
- * @return
+ * @return ret a mapping of models for a given model
*/
public Map<Model, List<ModelEndpoint>> listEndpoints(Model model) {
Map<Model, List<ModelEndpoint>> ret = new HashMap<>();
http://git-wip-us.apache.org/repos/asf/metron/blob/4c908b95/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java
----------------------------------------------------------------------
diff --git a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java
index bebef9b..1338b7b 100644
--- a/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java
+++ b/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java
@@ -42,7 +42,7 @@ public enum QueueHandler {
/**
* Create a queue handler of the specific type
* @param config
- * @return
+ * @return queue handler of the specific type
*/
public Queue<ModelRequest> create(Map<String, Object> config) {
return queueCreator.apply(config);