Repository: incubator-edgent Updated Branches: refs/heads/master 08944e5f0 -> e440dad54
[Edgent-424] Cleanup things maven-javadoc-plugin 2.10.4 complains about Seen when failOnError is enabled - remove cross project links to non-dependent projects - remove anchor refs from @see - replace problem '>' with > - remove problem </P> Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent/commit/e440dad5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent/tree/e440dad5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent/diff/e440dad5 Branch: refs/heads/master Commit: e440dad54b94ce0b7e2d5bbd4273e53db4132ee9 Parents: 08944e5 Author: Dale LaBossiere <dlab...@us.ibm.com> Authored: Thu Jun 22 16:10:17 2017 -0400 Committer: Dale LaBossiere <dlab...@us.ibm.com> Committed: Thu Jun 22 16:10:17 2017 -0400 ---------------------------------------------------------------------- .../apache/edgent/analytics/math3/Aggregations.java | 14 +++++++------- .../edgent/analytics/math3/json/JsonAnalytics.java | 2 +- .../apache/edgent/execution/mbeans/PeriodMXBean.java | 2 +- .../edgent/execution/services/ControlService.java | 2 +- .../main/java/org/apache/edgent/topology/TWindow.java | 2 -- .../apache/edgent/topology/json/JsonFunctions.java | 1 + .../apache/edgent/topology/mbeans/package-info.java | 12 ++++++++---- .../edgent/topology/plumbing/PlumbingStreams.java | 2 +- .../connectors/command/runtime/ProcessReader.java | 4 ++-- .../org/apache/edgent/connectors/iot/Commands.java | 4 ++-- .../org/apache/edgent/connectors/iotp/IotpDevice.java | 9 +++++---- .../edgent/test/connectors/mqtt/MqttOpenTest.java | 2 +- .../org/apache/edgent/providers/iot/IotProvider.java | 4 ++-- .../org/apache/edgent/streamscope/StreamScope.java | 2 +- .../edgent/streamscope/StreamScopeRegistry.java | 2 +- .../streamscope/mbeans/StreamScopeRegistryMXBean.java | 2 +- 16 files changed, 35 insertions(+), 31 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java ---------------------------------------------------------------------- diff --git a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java index 4250e83..bcc9ea0 100644 --- a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java +++ b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java @@ -60,12 +60,12 @@ import org.apache.edgent.topology.TWindow; * double getTemp() {...}; * double getPressure() {...}; * ... }; - *TStream<SensorReading> readings = ... - *TWindow<SensorReading,Integer> window = sensorReadings.last(5, Functions.unpartitioned()); - *TStream<MvResultMap> aggregations = window.batch( - * (list, partition) -> { - * ResultMap pressureResults = Aggregations.aggregateN(list, t -> t.getPressure(), Statistic2.MEAN, Regression2.SLOPE)); - * ResultMap tempResults = Aggregations.aggregateN(list, t -> t.getTemp(), Statistic2.MAX)); + *TStream<SensorReading> readings = ... + *TWindow<SensorReading,Integer> window = sensorReadings.last(5, Functions.unpartitioned()); + *TStream<MvResultMap> aggregations = window.batch( + * (list, partition) -> { + * ResultMap pressureResults = Aggregations.aggregateN(list, t -> t.getPressure(), Statistic2.MEAN, Regression2.SLOPE)); + * ResultMap tempResults = Aggregations.aggregateN(list, t -> t.getTemp(), Statistic2.MAX)); * MvResultMap results = Aggregations.newMvResults(); * results.put("pressure", pressureResults); * results.put("temp", tempResults); @@ -98,7 +98,7 @@ import org.apache.edgent.topology.TWindow; * <p>As a result, using JsonAnalytics for simple cases can be a bit unintuitive and cumbersome. * * <p>For example, to JsonAnalytics for a simple case of a continuous aggregation - * of {@code TStream<Double>} => {@code TStream<Double>} of MEAN values: + * of {@code TStream<Double>} => {@code TStream<Double>} of MEAN values: * * <pre>{@code * TStream<Double> pressureReadings = ... http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java ---------------------------------------------------------------------- diff --git a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java index cfe1a78..8335757 100644 --- a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java +++ b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java @@ -253,7 +253,7 @@ public class JsonAnalytics { * @param resultPartitionKeyProperty name of the partition key property in the result * @param resultProperty name of the aggregation results property in the result * @param aggregateSpecs see {@link #mkAggregationSpec(String, JsonUnivariateAggregate...) mkAggregationSpec()} - * @return TStream<JsonObject> with aggregation results + * @return TStream<JsonObject> with aggregation results * * @see #mvAggregateList(String, String, List) mvAggregateList() * @see #mkAggregationSpec(String, JsonUnivariateAggregate...) mkAggregationSpec() http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java ---------------------------------------------------------------------- diff --git a/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java b/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java index 54d3b5b..6fe58e7 100644 --- a/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java +++ b/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java @@ -31,7 +31,7 @@ import java.util.concurrent.TimeUnit; * {@link org.apache.edgent.execution.services.ControlService ControlService}. * </P> * - * @see org.apache.edgent.topology.Topology#poll(org.apache.edgent.function.Supplier, long, TimeUnit) + * See {@code org.apache.edgent.topology.Topology.poll(org.apache.edgent.function.Supplier, long, TimeUnit)} */ public interface PeriodMXBean { http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java ---------------------------------------------------------------------- diff --git a/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java b/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java index 635ae92..6671017 100644 --- a/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java +++ b/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java @@ -30,7 +30,7 @@ package org.apache.edgent.execution.services; * <P> * Different implementations of the control service provide the mechanism * to execute methods of the control interfaces. For example - * {@link org.apache.edgent.runtime.jmxcontrol.JMXControlService JMXControlService} + * {@code JMXControlService} * registers the MBeans in the JMX platform MBean server. * <BR> * The control service is intended to allow remote execution of a control interface http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java ---------------------------------------------------------------------- diff --git a/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java b/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java index 2665a76..5c61027 100644 --- a/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java +++ b/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java @@ -64,7 +64,6 @@ public interface TWindow<T, K> extends TopologyElement { * empty if the eviction results in an empty partition.</LI> * </UL> * A non-null {@code aggregator} result is added to the returned stream. - * </P> * <P> * Thus the returned stream will contain a sequence of tuples where the * most recent tuple represents the most up to date aggregation of a @@ -93,7 +92,6 @@ public interface TWindow<T, K> extends TopologyElement { * </UL> * A non-null {@code batcher} result is added to the returned stream. * The partition's contents are cleared after a batch is processed. - * </P> * <P> * Thus the returned stream will contain a sequence of tuples where the * most recent tuple represents the most up to date aggregation of a http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java ---------------------------------------------------------------------- diff --git a/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java b/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java index 37a9eea..fe744ec 100644 --- a/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java +++ b/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java @@ -101,6 +101,7 @@ public class JsonFunctions { * <p>Returns a Function whose {@code apply(T v)} returns a JsonObject having * a single property named {@code propName} with the value of {@code v}. * + * @param <T> type of number * @param propName property name * @return the Function */ http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java ---------------------------------------------------------------------- diff --git a/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java b/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java index e5035c3..52cc4a5 100644 --- a/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java +++ b/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java @@ -18,6 +18,10 @@ under the License. */ /** * Controls for executing topologies. + * <P> + * The "Attribute Name" column values below correspond to {@code KEY} values defined + * in {@code org.apache.edgent.runtime.jsoncontrol.JsonControlService}. + * * <h3>Application Service </h3> * {@linkplain org.apache.edgent.topology.services.ApplicationService Application service} * allows an application to be registered @@ -39,26 +43,26 @@ under the License. * <th id="desc" align=center><b>Description</b></th> * </tr> * <tr> - * <td headers="attrName">{@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#TYPE_KEY type}</td> + * <td headers="attrName">{@code type}</td> * <td headers="type">String</td> * <td headers="value">{@link org.apache.edgent.topology.mbeans.ApplicationServiceMXBean#TYPE appService}</td> * <td headers="desc">{@code ApplicationServiceMXBean} control MBean type.</td> * </tr> * <tr> - * <td headers="attrName">{@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#OP_KEY op}</td> + * <td headers="attrName">{@code op}</td> * <td headers="type">String</td> * <td headers="value">{@code submit}</td> * <td headers="desc">Invoke {@link org.apache.edgent.topology.mbeans.ApplicationServiceMXBean#submit(String, String) submit} operation * against the control MBean.</td> * </tr> * <tr> - * <td headers="attrName">{@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#ALIAS_KEY alias}</td> + * <td headers="attrName">{@code alias}</td> * <td headers="type">String</td> * <td headers="value">Alias of control MBean.</td> * <td headers="desc">Default is {@link org.apache.edgent.topology.services.ApplicationService#ALIAS edgent}.</td> * </tr> * <tr> - * <td rowspan="2" headers="attrName">{@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#ARGS_KEY args}</td> + * <td rowspan="2" headers="attrName">{@code args}</td> * <td rowspan="2" headers="type">List</td> * <td headers="value">String: application name</td> * <td headers="desc">Registered application to submit.</td> http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java ---------------------------------------------------------------------- diff --git a/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java b/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java index e551642..0df80ad 100644 --- a/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java +++ b/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java @@ -557,7 +557,7 @@ public class PlumbingStreams { * }</pre> * <P> * Note, this implementation requires that the splitter is used from - * only a single JVM. The {@link org.apache.edgent.providers.direct.DirectProvider DirectProvider} + * only a single JVM. The {@code org.apache.edgent.providers.direct.DirectProvider} * provider meets this requirement. * </P> * http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java ---------------------------------------------------------------------- diff --git a/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java b/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java index 47a2c59..e4560f0 100644 --- a/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java +++ b/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java @@ -30,8 +30,8 @@ import org.apache.edgent.function.Supplier; /** * A {@code Supplier<Iterable<String>>} for ingesting a process's output. * <P> - * The iterator returned by {@link Iterable#iterator()) returns - * {@hasNext()==true} until a read from {@link Process#getInputStream()} + * The iterator returned by {@link Iterable#iterator()} returns + * {@code hasNext()==true} until a read from {@link Process#getInputStream()} * returns EOF or an IOError. */ class ProcessReader implements Supplier<Iterable<String>> { http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java ---------------------------------------------------------------------- diff --git a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java index 22c866b..0f8626a 100644 --- a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java +++ b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java @@ -30,12 +30,12 @@ public interface Commands { * <BR> * The command payload is used to invoke operations * against control MBeans using an instance of - * {@link org.apache.edgent.runtime.jsoncontrol.JsonControlService}. + * {@code org.apache.edgent.runtime.jsoncontrol.JsonControlService}. * <BR> * Value is {@value}. * * @see org.apache.edgent.execution.services.ControlService - * @see org.apache.edgent.providers.iot.IotProvider + * See {@code org.apache.edgent.providers.iot.IotProvider} */ String CONTROL_SERVICE = IotDevice.RESERVED_ID_PREFIX + "Control"; http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java ---------------------------------------------------------------------- diff --git a/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java b/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java index caab29a..621b342 100644 --- a/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java +++ b/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java @@ -51,7 +51,7 @@ import com.ibm.iotf.client.device.DeviceClient; * scale message hub that provides a device model on top of MQTT. * {@code IotpDevice} implements the generic device model {@link IotDevice} * and thus can be used as a connector for - * {@link org.apache.edgent.providers.iot.IotProvider}. + * {@code org.apache.edgent.providers.iot.IotProvider}. * <BR> * <em>Note IBM Watson IoT Platform was previously known as * IBM Internet of Things Foundation.</em> @@ -81,8 +81,9 @@ import com.ibm.iotf.client.device.DeviceClient; * for details of changes that occurred to device event payloads * and how to revert the behavior if needed. * <p> - * @see <a href="{@docRoot}/org/apache/edgent/connectors/iot/package-summary.html">Edgent generic device model</a> - * @see org.apache.edgent.samples.connectors.iotp.IotpSensors Sample application + * See <a href="{@docRoot}/org/apache/edgent/connectors/iot/package-summary.html">Edgent generic device model</a> + * <p> + * See {@code org.apache.edgent.samples.connectors.iotp.IotpSensors} Sample application */ public class IotpDevice implements IotDevice { @@ -199,7 +200,7 @@ public class IotpDevice implements IotDevice { * @return Connector to the Quickstart service. * * @see <a href="https://quickstart.internetofthings.ibmcloud.com">Quickstart</a> - * @see org.apache.edgent.samples.connectors.iotp.IotpQuickstart Quickstart sample application + * See {@code org.apache.edgent.samples.connectors.iotp.IotpQuickstart Quickstart} sample application */ public static IotpDevice quickstart(Topology topology, String deviceId) { Properties options = new Properties(); http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java ---------------------------------------------------------------------- diff --git a/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java b/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java index 22f2f4c..4cde14c 100644 --- a/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java +++ b/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java @@ -32,7 +32,7 @@ import org.junit.rules.TestName; /** * Uses the MQTT test broker at: tcp://test.mosquitto.org:1883 * - * @see <a href="http://test.mosquitto.org/">http://test.mosquitto.org/</a> + * See <a href="http://test.mosquitto.org/">http://test.mosquitto.org/</a> * * The tests are skipped if unable to connect (e.g., due to firewall config, * or the public broker not available for whatever reason). http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java ---------------------------------------------------------------------- diff --git a/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java b/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java index 368d00e..4ebdcca 100644 --- a/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java +++ b/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java @@ -64,8 +64,8 @@ import com.google.gson.JsonObject; * class MyApp { * ... * public void run(String[] args) throws Exception { - * IotProvider provider = new IotProvider((top) -> new IotpDevice(top, myDeviceConfig)); - * provider.registerTopology("app1", (iotDevice, cfg) -> buildApp1(iotDevice, cfg)); + * IotProvider provider = new IotProvider((top) -> new IotpDevice(top, myDeviceConfig)); + * provider.registerTopology("app1", (iotDevice, cfg) -> buildApp1(iotDevice, cfg)); * provider.start(); * } * private void buildApp1(IotDevice iotDevice, JsonConfig cfg) { http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java ---------------------------------------------------------------------- diff --git a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java index 55569ce..e067678 100644 --- a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java +++ b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java @@ -50,7 +50,7 @@ import org.apache.edgent.streamscope.mbeans.StreamScopeRegistryMXBean; * and {@link StreamScopeRegistryMXBean} runtime ControlService. * </P> * @see StreamScopeRegistry - * @see org.apache.edgent.providers.development.DevelopmentProvider DevelopmentProvider + * See {@code org.apache.edgent.providers.development.DevelopmentProvider} * * @param <T> Tuple type */ http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java ---------------------------------------------------------------------- diff --git a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java index e619708..6a71325 100644 --- a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java +++ b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java @@ -37,7 +37,7 @@ import java.util.Set; * Static methods are provided for composing these names and extracting * the alias/identifier from generated names. * </P> - * @see org.apache.edgent.providers.development.DevelopmentProvider DevelopmentProvider + * See {@code org.apache.edgent.providers.development.DevelopmentProvider} */ public class StreamScopeRegistry { private final Map<String, StreamScope<?>> byNameMap = new HashMap<>(); http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/e440dad5/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java ---------------------------------------------------------------------- diff --git a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java index 2637259..2f1d6a2 100644 --- a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java +++ b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java @@ -24,7 +24,7 @@ package org.apache.edgent.streamscope.mbeans; * The registry contains a collection of StreamScopeMXBean instances * that are registered by a stream identifier. * </P> - * @see org.apache.edgent.providers.development.DevelopmentProvider DevelopmentProvider + * See {@code org.apache.edgent.providers.development.DevelopmentProvider} */ public interface StreamScopeRegistryMXBean {