You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by da...@apache.org on 2021/05/13 16:11:45 UTC
[sling-slingfeature-maven-plugin] branch master updated: Fix up
javadoc in preparation for release
This is an automated email from the ASF dual-hosted git repository.
davidb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-slingfeature-maven-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 4958290 Fix up javadoc in preparation for release
4958290 is described below
commit 4958290541b71b618137548624925b19f1c54c6d
Author: David Bosschaert <da...@apache.org>
AuthorDate: Thu May 13 17:11:13 2021 +0100
Fix up javadoc in preparation for release
Also fixed up some incorrect imports
---
.../java/org/apache/sling/feature/maven/JSONFeatures.java | 6 +++++-
.../java/org/apache/sling/feature/maven/ProjectHelper.java | 6 ++++++
.../sling/feature/maven/mojos/AbstractFeatureMojo.java | 4 ++--
.../feature/maven/mojos/AbstractIncludingFeatureMojo.java | 11 +++++------
.../sling/feature/maven/mojos/apis/ApisConfiguration.java | 6 +++---
.../sling/feature/maven/mojos/apis/ApisJarContext.java | 10 +++++-----
.../org/apache/sling/feature/maven/mojos/apis/ApisUtil.java | 12 +++++++++---
.../apache/sling/feature/maven/mojos/apis/RegionSupport.java | 9 +++++++++
.../sling/feature/maven/mojos/apis/spi/ProcessorContext.java | 2 ++
9 files changed, 46 insertions(+), 20 deletions(-)
diff --git a/src/main/java/org/apache/sling/feature/maven/JSONFeatures.java b/src/main/java/org/apache/sling/feature/maven/JSONFeatures.java
index f32b1be..f63bf1b 100644
--- a/src/main/java/org/apache/sling/feature/maven/JSONFeatures.java
+++ b/src/main/java/org/apache/sling/feature/maven/JSONFeatures.java
@@ -123,7 +123,11 @@ public class JSONFeatures {
private static final String FILE_PREFIX = "@file";
/**
- * Check for extensions of type text and if they reference a file
+ * Check for extensions of type text and if they reference a file.
+ *
+ * @param feature The feature to check
+ * @param file The file to check for
+ * @throws IOException when an IO Exception occurs
*/
public static void handleExtensions(final Feature feature, final File file) throws IOException {
for(final Extension ext : feature.getExtensions()) {
diff --git a/src/main/java/org/apache/sling/feature/maven/ProjectHelper.java b/src/main/java/org/apache/sling/feature/maven/ProjectHelper.java
index 2adc1fb..6405dbf 100644
--- a/src/main/java/org/apache/sling/feature/maven/ProjectHelper.java
+++ b/src/main/java/org/apache/sling/feature/maven/ProjectHelper.java
@@ -515,6 +515,7 @@ public abstract class ProjectHelper {
* Validate the classifiers in a project
* @param project The maven project
* @param additionalClassifier Optional additional classifier
+ * @param attachFeature Set to true to attach the feature
*/
public static void validateFeatureClassifiers(final MavenProject project,
final String additionalClassifier, final boolean attachFeature) {
@@ -593,7 +594,12 @@ public abstract class ProjectHelper {
/**
* Read the json file, minify it, add id if missing and replace variables
*
+ * @param project The Maven project to use
* @param file The json file
+ * @param suggestedClassifier The suggested classifier
+ * @param legacyReplace if the old replace is enabled
+ * @param enableProjectVars is the project variables are enabled
+ * @param additionalVars any additional variables
* @return The read and minified JSON
*/
public static String readFeatureFile(final MavenProject project,
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/AbstractFeatureMojo.java b/src/main/java/org/apache/sling/feature/maven/mojos/AbstractFeatureMojo.java
index dab9549..08cb5fd 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/AbstractFeatureMojo.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/AbstractFeatureMojo.java
@@ -219,7 +219,7 @@ public abstract class AbstractFeatureMojo extends AbstractMojo {
/**
* This method needs to be invoked by each mojo that deals with features
*
- * @throws MojoExecutionException
+ * @throws MojoExecutionException If the project has no features defined
*/
protected void checkPreconditions() throws MojoExecutionException {
final String errorMessage = ProjectHelper.checkPreprocessorRun(this.project);
@@ -299,7 +299,7 @@ public abstract class AbstractFeatureMojo extends AbstractMojo {
// Default metadata
JSONFeatures.handleDefaultMetadata(feature, ProjectHelper.getDefaultMetadata(project));
-
+
ProjectHelper.setFeatureInfo(project, feature);
// Add feature to map of features
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/AbstractIncludingFeatureMojo.java b/src/main/java/org/apache/sling/feature/maven/mojos/AbstractIncludingFeatureMojo.java
index 6dcef11..fdcbe54 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/AbstractIncludingFeatureMojo.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/AbstractIncludingFeatureMojo.java
@@ -19,6 +19,8 @@ package org.apache.sling.feature.maven.mojos;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
@@ -33,16 +35,13 @@ import org.apache.sling.feature.io.IOUtils;
import org.apache.sling.feature.maven.ProjectHelper;
import org.codehaus.plexus.util.AbstractScanner;
-import edu.emory.mathcs.backport.java.util.Arrays;
-import edu.emory.mathcs.backport.java.util.Collections;
-
public abstract class AbstractIncludingFeatureMojo extends AbstractFeatureMojo {
/**
* Get all selected features for the provided configuration
* @param config The selection configuration
* @return An ordered map of features
- * @throws MojoExecutionException
+ * @throws MojoExecutionException If an incorrect configuration is found
*/
protected Map<String, Feature> getSelectedFeatures(final FeatureSelectionConfig config)
throws MojoExecutionException {
@@ -79,7 +78,7 @@ public abstract class AbstractIncludingFeatureMojo extends AbstractFeatureMojo {
/**
* Select all feature files from the project
* @return Ordered map of feature files
- * @throws MojoExecutionException
+ * @throws MojoExecutionException If an incorrect configuration is found
*/
protected Map<String, Feature> selectAllFeatureFiles() throws MojoExecutionException {
final FeatureSelectionConfig config = new FeatureSelectionConfig();
@@ -91,7 +90,7 @@ public abstract class AbstractIncludingFeatureMojo extends AbstractFeatureMojo {
/**
* Select all features including aggregates from the project
* @return Ordered map of features
- * @throws MojoExecutionException
+ * @throws MojoExecutionException If an incorrect configuration is found
*/
protected Map<String, Feature> selectAllFeatureFilesAndAggregates() throws MojoExecutionException {
final FeatureSelectionConfig config = new FeatureSelectionConfig();
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisConfiguration.java b/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisConfiguration.java
index 35eff8c..8818ec2 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisConfiguration.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisConfiguration.java
@@ -489,7 +489,7 @@ public class ApisConfiguration {
}
/**
- * @param useApiDependencies the useApiDependencies to set
+ * @param flag The value for useApiDependencies
*/
public void setUseApiDependencies(final boolean flag) {
this.useApiDependencies = flag;
@@ -503,7 +503,7 @@ public class ApisConfiguration {
}
/**
- * @param useApiDependenciesForJavadoc the useApiDependenciesForJavadoc to set
+ * @param flag The value for useApiDependenciesForJavadoc
*/
public void setUseApiDependenciesForJavadoc(final boolean flag) {
this.useApiDependenciesForJavadoc = flag;
@@ -542,5 +542,5 @@ public class ApisConfiguration {
this.dependencyRepositories.add(val);
}
}
- }
+ }
}
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisJarContext.java b/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisJarContext.java
index cda3dff..97a769b 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisJarContext.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisJarContext.java
@@ -175,7 +175,7 @@ public class ApisJarContext {
* <li>The artifact itself is used
* </ol>
* @return The list of dependency artifacts
- * @throws MojoExecutionException
+ * @throws MojoExecutionException If an incorrect configuration is found
*/
public List<ArtifactId> getDependencyArtifacts() throws MojoExecutionException {
final List<ArtifactId> dependencies = new ArrayList<>();
@@ -216,7 +216,7 @@ public class ApisJarContext {
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
-
+
@Override
public int hashCode() {
return Objects.hash(artifact);
@@ -225,7 +225,7 @@ public class ApisJarContext {
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
-
+
@Override
public boolean equals(Object obj) {
if (this == obj)
@@ -332,7 +332,7 @@ public class ApisJarContext {
}
return null;
}
-
+
public List<ArtifactInfo> getArtifactInfos() {
return this.infos;
}
@@ -391,7 +391,7 @@ public class ApisJarContext {
* @param log The logger
* @param info The artifact info
* @return {@code true} if all artifacts are publically available
- * @throws MojoExecutionException
+ * @throws MojoExecutionException If an incorrect configuration is found
*/
public boolean findDependencyArtifact(final Log log, final ArtifactInfo info) throws MojoExecutionException {
boolean result = true;
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisUtil.java b/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisUtil.java
index 455d74c..5393971 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisUtil.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/apis/ApisUtil.java
@@ -200,7 +200,13 @@ public class ApisUtil {
/**
* Build the classpath for javadoc
- * @throws MojoExecutionException
+ *
+ * @param log The log to use
+ * @param repositorySystem The repository system to use
+ * @param mavenSession The maven session to use
+ * @param ctx The Apis Jar Context to use
+ * @param regionName The region name to use
+ * @throws MojoExecutionException When an invalid artifact ID is found
*/
public static Collection<String> getJavadocClassPath(final Log log,
final RepositorySystem repositorySystem,
@@ -484,7 +490,7 @@ public class ApisUtil {
public int compare(ArtifactInfo o1, ArtifactInfo o2) {
return o1.getId().compareTo(o2.getId());
}
-
+
});
final List<String> output = new ArrayList<>();
for (final ArtifactInfo info : infos) {
@@ -511,6 +517,6 @@ public class ApisUtil {
if ( reportFile.exists() ) {
reportFile.delete();
}
- }
+ }
}
}
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/apis/RegionSupport.java b/src/main/java/org/apache/sling/feature/maven/mojos/apis/RegionSupport.java
index 2a1b4c0..a8febb3 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/apis/RegionSupport.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/apis/RegionSupport.java
@@ -172,7 +172,12 @@ public class RegionSupport {
/**
* Compute exports based on all regions
*
+ * @param apiRegions The API Regions to use
+ * @param enabledToggles The enabled toggles
+ * @param exportedPackages The exported packages
+ * @param bundle The bundle
* @return Set of packages exported by this bundle and used in any region
+ * @throws MojoExecutionException when the calculation cannot be made
*/
public Set<String> computeAllUsedExportPackages(final ApiRegions apiRegions,
final Set<String> enabledToggles,
@@ -203,7 +208,11 @@ public class RegionSupport {
/**
* Compute exports based on a single region
*
+ * @param apiRegion The API Region to use
+ * @param exportedPackages The exported packages
+ * @param allPackages All the packages
* @return List of packages exported by this bundle and used in the region
+ * @throws MojoExecutionException When the computation cannot be done.
*/
public Set<Clause> computeUsedExportPackagesPerRegion(final ApiRegion apiRegion,
final Clause[] exportedPackages,
diff --git a/src/main/java/org/apache/sling/feature/maven/mojos/apis/spi/ProcessorContext.java b/src/main/java/org/apache/sling/feature/maven/mojos/apis/spi/ProcessorContext.java
index 96696ce..e2c20f6 100644
--- a/src/main/java/org/apache/sling/feature/maven/mojos/apis/spi/ProcessorContext.java
+++ b/src/main/java/org/apache/sling/feature/maven/mojos/apis/spi/ProcessorContext.java
@@ -47,11 +47,13 @@ public interface ProcessorContext {
/**
* Get the session
+ * @return The session
*/
MavenSession getSession();
/**
* The logger
+ * @return The log
*/
Log getLog();
}