You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2017/06/01 11:45:05 UTC

svn commit: r1797203 - in /sling/whiteboard/cziegeler/feature-analyser: pom.xml src/main/java/org/apache/sling/feature/analyser/AnalyserTask.java src/main/java/org/apache/sling/feature/analyser/AnalyserTaskContext.java

Author: cziegeler
Date: Thu Jun  1 11:45:04 2017
New Revision: 1797203

URL: http://svn.apache.org/viewvc?rev=1797203&view=rev
Log:
Use feature support

Modified:
    sling/whiteboard/cziegeler/feature-analyser/pom.xml
    sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTask.java
    sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTaskContext.java

Modified: sling/whiteboard/cziegeler/feature-analyser/pom.xml
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature-analyser/pom.xml?rev=1797203&r1=1797202&r2=1797203&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature-analyser/pom.xml (original)
+++ sling/whiteboard/cziegeler/feature-analyser/pom.xml Thu Jun  1 11:45:04 2017
@@ -73,6 +73,12 @@
         </dependency>
         <dependency>
             <groupId>org.apache.sling</groupId>
+            <artifactId>org.apache.sling.feature.support</artifactId>
+            <version>0.0.1-SNAPSHOT</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.sling</groupId>
             <artifactId>org.apache.sling.commons.osgi</artifactId>
             <version>2.4.0</version>
             <scope>provided</scope>

Modified: sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTask.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTask.java?rev=1797203&r1=1797202&r2=1797203&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTask.java (original)
+++ sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTask.java Thu Jun  1 11:45:04 2017
@@ -16,10 +16,16 @@
  */
 package org.apache.sling.feature.analyser;
 
+/**
+ * A analyser task analyses a specific part of the assembled
+ * application. It can report errors and warnings.
+ */
 public interface AnalyserTask {
 
+    /** A human readable name to identify the task. */
     String getName();
 
+    /** Execute the task. */
     void execute(AnalyserTaskContext ctx);
 }
 

Modified: sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTaskContext.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTaskContext.java?rev=1797203&r1=1797202&r2=1797203&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTaskContext.java (original)
+++ sling/whiteboard/cziegeler/feature-analyser/src/main/java/org/apache/sling/feature/analyser/AnalyserTaskContext.java Thu Jun  1 11:45:04 2017
@@ -23,18 +23,48 @@ import org.apache.sling.feature.KeyValue
 
 public interface AnalyserTaskContext {
 
+    /**
+     * The assembled application.
+     * @return The application.
+     */
     Application getApplication();
 
-    KeyValueMap<String> getDefaultFrameworkProperties();
-
+    /**
+     * Framework properties already set by the launcher/framework
+     * @return The map with properties.
+     */
+    KeyValueMap getDefaultFrameworkProperties();
+
+    /**
+     * The list of system packages exported by the framework itself
+     * @return Unmodifiable list of system package.
+     */
     List<PackageInfo> getSystemPackages();
 
+    /**
+     * Get the list of bundle infos.
+     * @return The unmodifiable list of bundle infos
+     */
     List<BundleInfo> getBundleInfos();
 
+    /**
+     * Get the list artifact infos
+     * @return The unmodifiable list of artifact infos
+     */
     List<ArtifactInfo> getArtifactInfos();
 
-    void addWarning(String message);
-
-    void addError(String message);
+    /**
+     * This method is invoked by a {@link AnalyserTask} to report
+     * a warning.
+     * @param message The message.
+     */
+    void reportWarning(String message);
+
+    /**
+     * This method is invoked by a {@link AnalyserTask} to report
+     * an error.
+     * @param message The message.
+     */
+    void reportError(String message);
 }