You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ri...@apache.org on 2023/01/20 15:34:54 UTC
[streampipes] 04/05: Add comments to intefaces (#1096)
This is an automated email from the ASF dual-hosted git repository.
riemer pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit d19b7e04252f113e740514fd93432b5b77dcc5ec
Author: Dominik Riemer <do...@gmail.com>
AuthorDate: Wed Jan 18 22:01:50 2023 +0100
Add comments to intefaces (#1096)
---
.../java/org/apache/streampipes/model/api/EndpointSelectable.java | 3 +++
.../manager/execution/provider/CurrentPipelineElementProvider.java | 4 ++++
.../manager/execution/provider/StoredPipelineElementProvider.java | 4 ++++
3 files changed, 11 insertions(+)
diff --git a/streampipes-model/src/main/java/org/apache/streampipes/model/api/EndpointSelectable.java b/streampipes-model/src/main/java/org/apache/streampipes/model/api/EndpointSelectable.java
index 585400010..f2a0fcedc 100644
--- a/streampipes-model/src/main/java/org/apache/streampipes/model/api/EndpointSelectable.java
+++ b/streampipes-model/src/main/java/org/apache/streampipes/model/api/EndpointSelectable.java
@@ -18,6 +18,9 @@
package org.apache.streampipes.model.api;
+/**
+ * Interface for pipeline elements which are invoked upon pipeline start (processors, sinks, sets)
+ */
public interface EndpointSelectable {
String getName();
diff --git a/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/CurrentPipelineElementProvider.java b/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/CurrentPipelineElementProvider.java
index 282f08537..aa1aeaecc 100644
--- a/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/CurrentPipelineElementProvider.java
+++ b/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/CurrentPipelineElementProvider.java
@@ -24,6 +24,10 @@ import org.apache.streampipes.model.base.InvocableStreamPipesEntity;
import java.util.List;
+/**
+ * Provides pipeline elements from the pipeline of interest (for start actions)
+ */
+
public class CurrentPipelineElementProvider implements PipelineElementProvider {
@Override
public List<InvocableStreamPipesEntity> getProcessorsAndSinks(PipelineExecutionInfo executionInfo) {
diff --git a/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/StoredPipelineElementProvider.java b/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/StoredPipelineElementProvider.java
index a41adbde7..ad5860711 100644
--- a/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/StoredPipelineElementProvider.java
+++ b/streampipes-pipeline-management/src/main/java/org/apache/streampipes/manager/execution/provider/StoredPipelineElementProvider.java
@@ -25,6 +25,10 @@ import org.apache.streampipes.model.base.InvocableStreamPipesEntity;
import java.util.List;
+/**
+ * Provides pipeline elements from the cache (for stop actions)
+ */
+
public class StoredPipelineElementProvider implements PipelineElementProvider {
@Override
public List<InvocableStreamPipesEntity> getProcessorsAndSinks(PipelineExecutionInfo executionInfo) {