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 2019/08/07 07:54:17 UTC
[sling-org-apache-sling-feature-analyser] branch master updated:
Remove unused imports and add some javadocs
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-analyser.git
The following commit(s) were added to refs/heads/master by this push:
new 634ac21 Remove unused imports and add some javadocs
634ac21 is described below
commit 634ac213ee7550c071edd6f1bd8fb76619410087
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Wed Aug 7 10:53:39 2019 +0300
Remove unused imports and add some javadocs
---
.../analyser/task/AnalyzerTaskProvider.java | 29 +++++++++++++++++-----
.../analyser/task/impl/CheckBundlesForConnect.java | 1 -
.../org/apache/sling/feature/scanner/Scanner.java | 1 -
.../scanner/impl/ContentPackageDescriptor.java | 9 +++----
.../impl/ContentPackagesExtensionScanner.java | 9 +++----
5 files changed, 31 insertions(+), 18 deletions(-)
diff --git a/src/main/java/org/apache/sling/feature/analyser/task/AnalyzerTaskProvider.java b/src/main/java/org/apache/sling/feature/analyser/task/AnalyzerTaskProvider.java
index e8225c3..f06d128 100644
--- a/src/main/java/org/apache/sling/feature/analyser/task/AnalyzerTaskProvider.java
+++ b/src/main/java/org/apache/sling/feature/analyser/task/AnalyzerTaskProvider.java
@@ -18,8 +18,6 @@
*/
package org.apache.sling.feature.analyser.task;
-import org.apache.sling.feature.analyser.Analyser;
-
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
@@ -28,19 +26,32 @@ import java.util.List;
import java.util.ServiceLoader;
import java.util.Set;
+import org.apache.sling.feature.analyser.Analyser;
+
public final class AnalyzerTaskProvider {
private AnalyzerTaskProvider() {
// this class must not be instantiated directly
}
+ /**
+ * Get all tasks. Calls {@link #getTasksByIds(null, null)}.
+ *
+ * @return The analyser tasks, array is never {@code null} but might be empty
+ */
public static AnalyserTask[] getTasks() {
return getTasksByIds(null, null);
}
- // includes can be null, means "include everything"
- // excludes can be null, means "do not exclude anything"
- // if both includes and excludes are null, method mehaves like getTasks()
+ /**
+ * Get all tasks and obey the includes/excludes rules. If both includes and
+ * excludes are null, method behaves like {@link #getTasks()}
+ *
+ * @param includes includes can be null, means "include everything"
+ * @param excludes excludes can be null, means "do not exclude anything"
+ * @return The analyser tasks, array is never {@code null} but might be empty
+ * @throws IllegalStateException If an included task is not found
+ */
public static AnalyserTask[] getTasksByIds(Set<String> includes, Set<String> excludes) {
if (excludes == null)
excludes = Collections.emptySet();
@@ -68,7 +79,13 @@ public final class AnalyzerTaskProvider {
return list.toArray(new AnalyserTask[list.size()]);
}
- // Get tasks from class names
+ /**
+ * Get tasks from class names
+ *
+ * @param taskClassNames The array of class names
+ * @return The analyser tasks, array is never {@code null} but might be empty
+ * @throws IOException If class names is null or loading fails
+ */
public static AnalyserTask[] getTasksByClassName(String...taskClassNames) throws IOException {
if (taskClassNames == null) {
throw new IOException("Impossible to load Tasks from a null string array");
diff --git a/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundlesForConnect.java b/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundlesForConnect.java
index b8443c8..ac82c48 100644
--- a/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundlesForConnect.java
+++ b/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundlesForConnect.java
@@ -18,7 +18,6 @@
*/
package org.apache.sling.feature.analyser.task.impl;
-import java.io.FileInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
diff --git a/src/main/java/org/apache/sling/feature/scanner/Scanner.java b/src/main/java/org/apache/sling/feature/scanner/Scanner.java
index 850e4a1..0a7e142 100644
--- a/src/main/java/org/apache/sling/feature/scanner/Scanner.java
+++ b/src/main/java/org/apache/sling/feature/scanner/Scanner.java
@@ -16,7 +16,6 @@
*/
package org.apache.sling.feature.scanner;
-import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
diff --git a/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackageDescriptor.java b/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackageDescriptor.java
index 5f56c75..a2565a5 100644
--- a/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackageDescriptor.java
+++ b/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackageDescriptor.java
@@ -16,16 +16,15 @@
*/
package org.apache.sling.feature.scanner.impl;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+
import org.apache.sling.feature.Artifact;
import org.apache.sling.feature.Configuration;
import org.apache.sling.feature.scanner.ArtifactDescriptor;
import org.apache.sling.feature.scanner.BundleDescriptor;
-import java.io.File;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.List;
-
/**
* Information about a content package.
*/
diff --git a/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackagesExtensionScanner.java b/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackagesExtensionScanner.java
index af4e502..22d0971 100644
--- a/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackagesExtensionScanner.java
+++ b/src/main/java/org/apache/sling/feature/scanner/impl/ContentPackagesExtensionScanner.java
@@ -16,6 +16,10 @@
*/
package org.apache.sling.feature.scanner.impl;
+import java.io.IOException;
+import java.net.URL;
+import java.util.Set;
+
import org.apache.sling.feature.Artifact;
import org.apache.sling.feature.Extension;
import org.apache.sling.feature.ExtensionType;
@@ -24,11 +28,6 @@ import org.apache.sling.feature.builder.ArtifactProvider;
import org.apache.sling.feature.scanner.ContainerDescriptor;
import org.apache.sling.feature.scanner.spi.ExtensionScanner;
-import java.io.File;
-import java.io.IOException;
-import java.net.URL;
-import java.util.Set;
-
public class ContentPackagesExtensionScanner implements ExtensionScanner {
@Override