You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by ca...@apache.org on 2016/07/06 00:17:04 UTC
[1/2] incubator-quarks git commit: Fix JavaDoc syntax and remove
wai-aria in table tag
Repository: incubator-quarks
Updated Branches:
refs/heads/master b2899a82c -> 37c823774
Fix JavaDoc syntax and remove wai-aria in table tag
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks/commit/5b94b799
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks/tree/5b94b799
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks/diff/5b94b799
Branch: refs/heads/master
Commit: 5b94b799b4ea83c41ab8629809333a08ada10997
Parents: 91796df
Author: cazen <ca...@apache.org>
Authored: Mon Jul 4 01:56:37 2016 +0000
Committer: cazen <ca...@apache.org>
Committed: Mon Jul 4 23:21:35 2016 +0000
----------------------------------------------------------------------
.../java/quarks/topology/mbeans/package-info.java | 2 +-
.../main/java/quarks/apps/runtime/JobMonitorApp.java | 3 ++-
.../java/quarks/connectors/runtime/Connector.java | 4 ++--
.../main/java/quarks/console/server/HttpServer.java | 4 ++--
.../main/java/quarks/providers/iot/package-info.java | 4 ++--
.../src/main/java/quarks/runtime/etiao/EtiaoJob.java | 7 ++++++-
.../scenarios/iotf/range/sensor/IotfRangeSensor.java | 7 ++++++-
.../java/quarks/topology/spi/AbstractTStream.java | 14 ++++++--------
8 files changed, 27 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/api/topology/src/main/java/quarks/topology/mbeans/package-info.java
----------------------------------------------------------------------
diff --git a/api/topology/src/main/java/quarks/topology/mbeans/package-info.java b/api/topology/src/main/java/quarks/topology/mbeans/package-info.java
index 44bc615..c27ea11 100644
--- a/api/topology/src/main/java/quarks/topology/mbeans/package-info.java
+++ b/api/topology/src/main/java/quarks/topology/mbeans/package-info.java
@@ -30,7 +30,7 @@ under the License.
*
* <h4 id="submitApp">Submit an Application</h4>
* Method: {@link quarks.topology.mbeans.ApplicationServiceMXBean#submit(String, String)}
- * <table border=1 cellpadding=3 cellspacing=1 aria-describedby="submitApp">
+ * <table border=1 cellpadding=3 cellspacing=1>
* <caption>JSON Submit Application</caption>
* <tr>
* <th id="attrName" align=center><b>Attribute name</b></th>
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/apps/runtime/src/main/java/quarks/apps/runtime/JobMonitorApp.java
----------------------------------------------------------------------
diff --git a/apps/runtime/src/main/java/quarks/apps/runtime/JobMonitorApp.java b/apps/runtime/src/main/java/quarks/apps/runtime/JobMonitorApp.java
index 39d67c6..8eef3fd 100644
--- a/apps/runtime/src/main/java/quarks/apps/runtime/JobMonitorApp.java
+++ b/apps/runtime/src/main/java/quarks/apps/runtime/JobMonitorApp.java
@@ -203,7 +203,8 @@ public class JobMonitorApp {
* <pre>
* JobEvents source --> Filter (health == unhealthy) --> Restart application
* </pre>
- *
+ * @param t Topology
+ *
*/
public static void declareTopology(Topology t) {
TStream<JsonObject> jobEvents = JobEvents.source(
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/connectors/common/src/main/java/quarks/connectors/runtime/Connector.java
----------------------------------------------------------------------
diff --git a/connectors/common/src/main/java/quarks/connectors/runtime/Connector.java b/connectors/common/src/main/java/quarks/connectors/runtime/Connector.java
index 8709673..213a91a 100644
--- a/connectors/common/src/main/java/quarks/connectors/runtime/Connector.java
+++ b/connectors/common/src/main/java/quarks/connectors/runtime/Connector.java
@@ -106,8 +106,8 @@ public abstract class Connector<T> implements AutoCloseable, Serializable {
/**
* Disconnect the connector after the specified period of inactivity.
- * @param idleTimeout
- * @param unit
+ * @param idleTimeout idleTimeout(long)
+ * @param unit TimeUnit
*/
public void setIdleTimeout(long idleTimeout, TimeUnit unit) {
idleManager.setIdleTimeoutMsec(unit.toMillis(idleTimeout));
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/console/server/src/main/java/quarks/console/server/HttpServer.java
----------------------------------------------------------------------
diff --git a/console/server/src/main/java/quarks/console/server/HttpServer.java b/console/server/src/main/java/quarks/console/server/HttpServer.java
index 537fbba..d80227b 100644
--- a/console/server/src/main/java/quarks/console/server/HttpServer.java
+++ b/console/server/src/main/java/quarks/console/server/HttpServer.java
@@ -108,7 +108,7 @@ public class HttpServer {
/**
*
* @return a String containing the context path to the console web application
- * @throws Exception
+ * @throws Exception on failure
*/
public String getConsoleContextPath() throws Exception {
return HttpServerHolder.WEBAPP.getContextPath();
@@ -167,7 +167,7 @@ public class HttpServer {
/**
* Returns the url for the web application at the "console" context path. Localhost is always assumed
* @return the url for the web application at the "console" context path.
- * @throws Exception
+ * @throws Exception on failure
*/
public String getConsoleUrl() throws Exception {
return new String("http://localhost" + ":" + getConsolePortNumber() + getConsoleContextPath());
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/providers/iot/src/main/java/quarks/providers/iot/package-info.java
----------------------------------------------------------------------
diff --git a/providers/iot/src/main/java/quarks/providers/iot/package-info.java b/providers/iot/src/main/java/quarks/providers/iot/package-info.java
index 333ae8d..7e6b15b 100644
--- a/providers/iot/src/main/java/quarks/providers/iot/package-info.java
+++ b/providers/iot/src/main/java/quarks/providers/iot/package-info.java
@@ -45,7 +45,7 @@ under the License.
* including arbitrary control mbeans registered by applications.
*
* <H4 id="providerOps">Provider operations</H4>
- * <TABLE border="1" aria-describedby="providerOps">
+ * <table border="1" summary="Provider operations">
* <tr>
* <th id="operation">Operation</th><th id="cmdIdentifier">Command identifier</th>
* <th id="type">Type</th><th id="alias">Alias</th><th id="method">Method</th><th id="args">Arguments</th>
@@ -76,7 +76,7 @@ under the License.
* <td colspan=5 headers="type alias method args controlMbean">{@code {"type":"job","alias":"Heartbeat","op":"stateChange","args":["CLOSE"]}}</td>
* </tr>
* <tr></tr>
- * </TABLE>
+ * </table>
*
*/
package quarks.providers.iot;
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/runtime/etiao/src/main/java/quarks/runtime/etiao/EtiaoJob.java
----------------------------------------------------------------------
diff --git a/runtime/etiao/src/main/java/quarks/runtime/etiao/EtiaoJob.java b/runtime/etiao/src/main/java/quarks/runtime/etiao/EtiaoJob.java
index c1fcbd9..85b9ec5 100644
--- a/runtime/etiao/src/main/java/quarks/runtime/etiao/EtiaoJob.java
+++ b/runtime/etiao/src/main/java/quarks/runtime/etiao/EtiaoJob.java
@@ -182,7 +182,12 @@ public class EtiaoJob extends AbstractGraphJob implements JobContext {
/**
* Complete job closing. This method can be invoked after a job close
- * has been initiated.
+ * has been initiated.
+ * @param timeout the time to wait
+ * @param unit TimeUnit
+ * @throws ExecutionException if the job execution threw an ExecutionException.
+ * @throws InterruptedException if the job execution threw an InterruptedException.
+ * @throws TimeoutException if the job execution threw an TimeoutException.
*/
public void completeClosing(long timeout, TimeUnit unit) throws ExecutionException, InterruptedException, TimeoutException {
if (unit == null)
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/samples/scenarios/src/main/java/quarks/samples/scenarios/iotf/range/sensor/IotfRangeSensor.java
----------------------------------------------------------------------
diff --git a/samples/scenarios/src/main/java/quarks/samples/scenarios/iotf/range/sensor/IotfRangeSensor.java b/samples/scenarios/src/main/java/quarks/samples/scenarios/iotf/range/sensor/IotfRangeSensor.java
index 842e267..bb87e4c 100644
--- a/samples/scenarios/src/main/java/quarks/samples/scenarios/iotf/range/sensor/IotfRangeSensor.java
+++ b/samples/scenarios/src/main/java/quarks/samples/scenarios/iotf/range/sensor/IotfRangeSensor.java
@@ -136,6 +136,8 @@ public class IotfRangeSensor {
* @param print
* True if the data submitted as events should also be printed to
* standard out.
+ * @param simulated
+ * boolean flag
*/
public static void rangeSensor(IotDevice device, boolean simulated, boolean print) {
@@ -197,7 +199,10 @@ public class IotfRangeSensor {
* Note to receive commands a analytic application must exist that generates
* them through IBM Watson IoT Platform.
* </P>
- *
+ *
+ * @param device IoTF device
+ * @return JSON object includes tsms(timestamp) and payload.msg(status)
+ *
* @see IotDevice#commands(String...)
*/
public static TStream<String> displayMessages(IotDevice device) {
http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/5b94b799/spi/topology/src/main/java/quarks/topology/spi/AbstractTStream.java
----------------------------------------------------------------------
diff --git a/spi/topology/src/main/java/quarks/topology/spi/AbstractTStream.java b/spi/topology/src/main/java/quarks/topology/spi/AbstractTStream.java
index bc71f0a..c1dcd7f 100644
--- a/spi/topology/src/main/java/quarks/topology/spi/AbstractTStream.java
+++ b/spi/topology/src/main/java/quarks/topology/spi/AbstractTStream.java
@@ -31,8 +31,9 @@ import quarks.topology.Topology;
/**
* Abstract stream that uses the functional primitives to implement most
* methods.
- * <P>
+ * <p>
* The functional primitives are:
+ * </p>
* <UL>
* <LI>{@link TStream#filter(quarks.function.Predicate)}</LI>
* <LI>{@link TStream#map(quarks.function.Function)}</LI>
@@ -40,8 +41,7 @@ import quarks.topology.Topology;
* </UL>
* These methods are unimplemented, thus left to the specific implementation
* used to build the topology.
- * </P>
- *
+ *
* @param <G>
* Type of the {@link Topology} implementation.
* @param <T>
@@ -74,18 +74,16 @@ public abstract class AbstractTStream<G extends Topology, T> implements TStream<
* a different object of the same type.
* If {@code modifier.apply(t)} returns {@code null} then no tuple
* is submitted to the returned stream for {@code t}.
- *
+ *
* <P>
* Example of modifying a stream {@code String} values by adding the suffix '{@code extra}'.
- *
+ * </P>
* <pre>
* <code>
* TStream<String> strings = ...
* TStream<String> modifiedStrings = strings.modify(t -> t.concat("extra"));
* </code>
* </pre>
- *
- * </P>
* <P>
* This method is equivalent to
* {@code map(Function<T,T> modifier}).
@@ -131,7 +129,7 @@ public abstract class AbstractTStream<G extends Topology, T> implements TStream<
* {@code other}. A stream cannot be unioned with itself, in this case
* {@code this} will be returned.
*
- * @param other
+ * @param other TStream
* @return A stream that is the union of {@code this} and {@code other}.
*/
@Override
[2/2] incubator-quarks git commit: Merge branch 'pr-160' This closes
#160
Posted by ca...@apache.org.
Merge branch 'pr-160'
This closes #160
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks/commit/37c82377
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks/tree/37c82377
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks/diff/37c82377
Branch: refs/heads/master
Commit: 37c823774b6bb6a2d8d72e44f50fa12e78dd97e9
Parents: b2899a8 5b94b79
Author: cazen <ca...@apache.org>
Authored: Wed Jul 6 00:16:41 2016 +0000
Committer: cazen <ca...@apache.org>
Committed: Wed Jul 6 00:16:41 2016 +0000
----------------------------------------------------------------------
.../java/quarks/topology/mbeans/package-info.java | 2 +-
.../main/java/quarks/apps/runtime/JobMonitorApp.java | 3 ++-
.../java/quarks/connectors/runtime/Connector.java | 4 ++--
.../main/java/quarks/console/server/HttpServer.java | 4 ++--
.../main/java/quarks/providers/iot/package-info.java | 4 ++--
.../src/main/java/quarks/runtime/etiao/EtiaoJob.java | 7 ++++++-
.../scenarios/iotf/range/sensor/IotfRangeSensor.java | 7 ++++++-
.../java/quarks/topology/spi/AbstractTStream.java | 14 ++++++--------
8 files changed, 27 insertions(+), 18 deletions(-)
----------------------------------------------------------------------