You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2019/11/26 17:51:26 UTC

svn commit: r1870468 - in /jackrabbit/commons/filevault-package-maven-plugin/trunk: ./ src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ src/main/java/org/apache/jackrabbi...

Author: kwin
Date: Tue Nov 26 17:51:26 2019
New Revision: 1870468

URL: http://svn.apache.org/viewvc?rev=1870468&view=rev
Log:
JCRVLT-365 switch to Jetbrains Null annotations

This closes #34

Modified:
    jackrabbit/commons/filevault-package-maven-plugin/trunk/pom.xml
    jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.java
    jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SimpleEmbedded.java
    jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
    jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportPackageBuilder.java
    jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DependencyResolver.java
    jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DirectoryValidationContext.java

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/pom.xml
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/pom.xml?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/pom.xml (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/pom.xml Tue Nov 26 17:51:26 2019
@@ -379,9 +379,9 @@
             <version>2.6</version>
         </dependency>
         <dependency>
-            <groupId>com.google.code.findbugs</groupId>
-            <artifactId>jsr305</artifactId>
-            <version>2.0.1</version>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>18.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
@@ -637,4 +637,4 @@ The vote fails if not enough votes are c
             </build>
         </profile>
     </profiles>
-</project>
\ No newline at end of file
+</project>

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.java?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.java Tue Nov 26 17:51:26 2019
@@ -22,10 +22,6 @@ import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.Collection;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
 import org.apache.jackrabbit.vault.packaging.PackageId;
 import org.apache.jackrabbit.vault.packaging.PackageInfo;
 import org.apache.jackrabbit.vault.packaging.VersionRange;
@@ -35,6 +31,8 @@ import org.apache.maven.artifact.Default
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.util.StringUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * This class represents a dependency to another content package.
@@ -234,7 +232,7 @@ public class MavenBasedPackageDependency
         return dependency;
     }
 
-    @CheckForNull
+    @Nullable
     public URI getLocation() {
         if (groupId != null && artifactId != null && mavenVersion != null) {
             // which version?
@@ -255,7 +253,7 @@ public class MavenBasedPackageDependency
         return sb.toString();
     }
 
-    public static URI mavenCoordinatesToUri(@Nonnull String groupId, @Nonnull String artifactId, @Nonnull String version, String classifier) {
+    public static URI mavenCoordinatesToUri(@NotNull String groupId, @NotNull String artifactId, @NotNull String version, String classifier) {
         StringBuilder ssp = new StringBuilder();
         ssp.append(groupId).append(":").append(artifactId).append(":").append(version).append(":zip");
         if (StringUtils.isNotEmpty(classifier)) {

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SimpleEmbedded.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SimpleEmbedded.java?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SimpleEmbedded.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SimpleEmbedded.java Tue Nov 26 17:51:26 2019
@@ -21,14 +21,13 @@ import java.util.Collection;
 import java.util.List;
 import java.util.Set;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
 import org.apache.jackrabbit.filevault.maven.packaging.impl.StringFilterSet;
 import org.apache.jackrabbit.vault.fs.config.ConfigurationException;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
 import org.apache.maven.project.MavenProject;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Abstract base class for all kinds of embeds (both OSGi bundles as well as subpackages)
@@ -140,7 +139,7 @@ public class SimpleEmbedded {
         return matches;
     }
 
-    @Nonnull
+    @NotNull
     public StringBuilder toString(@Nullable StringBuilder builder) {
         if (builder == null) {
             builder = new StringBuilder();

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java Tue Nov 26 17:51:26 2019
@@ -33,8 +33,6 @@ import java.util.Map.Entry;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import javax.annotation.Nonnull;
-
 import org.apache.jackrabbit.vault.fs.api.PathFilterSet;
 import org.apache.jackrabbit.vault.fs.config.ConfigurationException;
 import org.apache.jackrabbit.vault.util.Constants;
@@ -63,6 +61,7 @@ import org.codehaus.plexus.archiver.util
 import org.codehaus.plexus.util.DirectoryScanner;
 import org.codehaus.plexus.util.FileUtils;
 import org.codehaus.plexus.util.StringUtils;
+import org.jetbrains.annotations.NotNull;
 
 /** Build a content package. */
 @Mojo(name = "package", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
@@ -196,8 +195,8 @@ public class VaultMojo extends AbstractS
      * @param directory the directory
      * @param prefix the prefix
      * @return the fileset */
-    @Nonnull
-    protected DefaultFileSet createFileSet(@Nonnull File directory, @Nonnull String prefix) {
+    @NotNull
+    protected DefaultFileSet createFileSet(@NotNull File directory, @NotNull String prefix) {
         return createFileSet(directory, prefix, null);
     }
 
@@ -207,8 +206,8 @@ public class VaultMojo extends AbstractS
      * @param prefix the prefix
      * @param additionalExcludes excludes
      * @return the fileset */
-    @Nonnull
-    protected DefaultFileSet createFileSet(@Nonnull File directory, @Nonnull String prefix, List<String> additionalExcludes) {
+    @NotNull
+    protected DefaultFileSet createFileSet(@NotNull File directory, @NotNull String prefix, List<String> additionalExcludes) {
         List<String> excludes = new LinkedList<>(this.excludes);
         if (additionalExcludes != null) {
             excludes.addAll(additionalExcludes);
@@ -275,7 +274,7 @@ public class VaultMojo extends AbstractS
         archiver.addFileSet(fileSet);
     }
 
-    private @Nonnull File applyFiltering(MavenResourcesExecution mavenResourcesExecution, Resource resource) throws MavenFilteringException {
+    private @NotNull File applyFiltering(MavenResourcesExecution mavenResourcesExecution, Resource resource) throws MavenFilteringException {
         File targetPath = new File(project.getBuild().getDirectory(), "filteredFiles");
         // which path to set as target (is a temporary path)
         getLog().debug("Applying filtering to resource " + resource);

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportPackageBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportPackageBuilder.java?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportPackageBuilder.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportPackageBuilder.java Tue Nov 26 17:51:26 2019
@@ -38,15 +38,14 @@ import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 import java.util.jar.Manifest;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.artifact.DependencyResolutionRequiredException;
 import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.util.DirectoryScanner;
 import org.codehaus.plexus.util.StringUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import aQute.bnd.header.Attrs;
 import aQute.bnd.header.Parameters;
@@ -133,7 +132,7 @@ public class ImportPackageBuilder {
      * @param classes the directory
      * @return this.
      */
-    @Nonnull
+    @NotNull
     public ImportPackageBuilder withClassFileDirectory(File classes) {
         classFileDirectory = classes;
         return this;
@@ -145,8 +144,8 @@ public class ImportPackageBuilder {
      * @param project the maven project
      * @return this
      */
-    @Nonnull
-    public ImportPackageBuilder withDependenciesFromProject(@Nonnull MavenProject project) {
+    @NotNull
+    public ImportPackageBuilder withDependenciesFromProject(@NotNull MavenProject project) {
         artifacts = new ArrayList<Artifact>();
         for (Artifact a : project.getDependencyArtifacts()) {
             if (!filter.include(a)) {
@@ -170,7 +169,7 @@ public class ImportPackageBuilder {
      * @param includeUnused {@code true} to include unused.
      * @return this
      */
-    @Nonnull
+    @NotNull
     public ImportPackageBuilder withIncludeUnused(boolean includeUnused) {
         this.includeUnused = includeUnused;
         return this;
@@ -181,8 +180,8 @@ public class ImportPackageBuilder {
      * @param filter the filter
      * @return this
      */
-    @Nonnull
-    public ImportPackageBuilder withFilter(@Nonnull ArtifactFilter filter) {
+    @NotNull
+    public ImportPackageBuilder withFilter(@NotNull ArtifactFilter filter) {
         this.filter = filter;
         return this;
     }
@@ -192,7 +191,7 @@ public class ImportPackageBuilder {
      * @return this
      * @throws IOException if an error occurrs.
      */
-    @Nonnull
+    @NotNull
     public ImportPackageBuilder analyze() throws IOException {
         initClassFiles();
         initAnalyzer();
@@ -207,7 +206,7 @@ public class ImportPackageBuilder {
      * returns the import parameter header. only available after {@link #analyze()}
      * @return the parameters
      */
-    @Nonnull
+    @NotNull
     public Map<String, Attrs> getImportParameters() {
         return importParameters;
     }
@@ -216,7 +215,7 @@ public class ImportPackageBuilder {
      * generates a package report
      * @return the report
      */
-    @Nonnull
+    @NotNull
     public String createExportPackageReport() {
         TreeSet<String> unusedBundles = new TreeSet<String>(bundles.keySet());
         StringBuilder report = new StringBuilder("Export package report:\n\n");
@@ -532,7 +531,7 @@ public class ImportPackageBuilder {
          * e.g. {@code /some/package/name/ClassFile.class}.
          * @return the paths.
          */
-        @Nonnull
+        @NotNull
         Collection<String> getClassFiles() throws IOException;
     }
 
@@ -556,7 +555,7 @@ public class ImportPackageBuilder {
         }
 
         @Override
-        @Nonnull
+        @NotNull
         public Collection<String> getClassFiles() throws IOException {
             List<String> fileNames = new LinkedList<>();
             try (JarFile jar = new JarFile(this.file)) {
@@ -602,7 +601,7 @@ public class ImportPackageBuilder {
         }
 
         @Override
-        @Nonnull
+        @NotNull
         public Collection<String> getClassFiles() throws IOException {
             Collection<File> files = listFiles(this.directory, new String[]{"class"}, true);
             String basePath = this.directory.getCanonicalPath();
@@ -632,4 +631,4 @@ public class ImportPackageBuilder {
             return clazz.getFQN();
         }
     }
-}
\ No newline at end of file
+}

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DependencyResolver.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DependencyResolver.java?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DependencyResolver.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DependencyResolver.java Tue Nov 26 17:51:26 2019
@@ -24,8 +24,6 @@ import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 
-import javax.annotation.CheckForNull;
-
 import org.apache.jackrabbit.filevault.maven.packaging.MavenBasedPackageDependency;
 import org.apache.jackrabbit.vault.packaging.Dependency;
 import org.apache.jackrabbit.vault.packaging.PackageId;
@@ -40,6 +38,7 @@ import org.apache.maven.artifact.resolve
 import org.apache.maven.artifact.resolver.ResolutionErrorHandler;
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.repository.RepositorySystem;
+import org.jetbrains.annotations.Nullable;
 
 /** Allows to resolve a {@link Dependency} from the underlying Maven repository (first local, then remote). */
 public class DependencyResolver {
@@ -93,7 +92,7 @@ public class DependencyResolver {
         return packageInfos;
     }
 
-    public @CheckForNull PackageInfo resolve(Dependency dependency, Log log) throws IOException {
+    public @Nullable PackageInfo resolve(Dependency dependency, Log log) throws IOException {
         // resolving a version range is not supported with Maven API, but only with lower level Aether API (requires Maven 3.5 or newer)
         // https://github.com/eclipse/aether-demo/blob/master/aether-demo-snippets/src/main/java/org/eclipse/aether/examples/FindAvailableVersions.java
         // therefore do an best effort resolve instead
@@ -126,7 +125,7 @@ public class DependencyResolver {
         return info;
     }
 
-    private @CheckForNull PackageInfo resolve(String groupId, String artifactId, String version, Log log) throws IOException {
+    private @Nullable PackageInfo resolve(String groupId, String artifactId, String version, Log log) throws IOException {
         Artifact artifact = repositorySystem.createArtifact(groupId, artifactId, version, "zip");
         File file = resolve(artifact, log);
         if (file != null) {
@@ -136,7 +135,7 @@ public class DependencyResolver {
         }
     }
 
-    private @CheckForNull File resolve(Artifact artifact, Log log) {
+    private @Nullable File resolve(Artifact artifact, Log log) {
         ArtifactResolutionRequest resolutionRequest = new ArtifactResolutionRequest(repositoryRequest);
         resolutionRequest.setArtifact(artifact);
         ArtifactResolutionResult result = repositorySystem.resolve(resolutionRequest);

Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DirectoryValidationContext.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DirectoryValidationContext.java?rev=1870468&r1=1870467&r2=1870468&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DirectoryValidationContext.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/validator/impl/context/DirectoryValidationContext.java Tue Nov 26 17:51:26 2019
@@ -24,8 +24,6 @@ import java.nio.file.Paths;
 import java.util.Collection;
 import java.util.List;
 
-import javax.annotation.Nonnull;
-
 import org.apache.jackrabbit.filevault.maven.packaging.GenerateMetadataMojo;
 import org.apache.jackrabbit.vault.fs.api.WorkspaceFilter;
 import org.apache.jackrabbit.vault.fs.config.ConfigurationException;
@@ -38,6 +36,7 @@ import org.apache.jackrabbit.vault.packa
 import org.apache.jackrabbit.vault.util.Constants;
 import org.apache.jackrabbit.vault.validation.spi.ValidationContext;
 import org.apache.maven.plugin.logging.Log;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Validation context built from files in two directories:
@@ -54,7 +53,7 @@ public class DirectoryValidationContext
     
     private static final Path RELATIVE_PROPERTIES_XML_PATH = Paths.get(Constants.VAULT_DIR, Constants.PROPERTIES_XML);
 
-    public DirectoryValidationContext(@Nonnull final File generatedMetaInfRootDirectory, final File metaInfRootDirectory, DependencyResolver resolver, @Nonnull final Log log) throws IOException, ConfigurationException {
+    public DirectoryValidationContext(@NotNull final File generatedMetaInfRootDirectory, final File metaInfRootDirectory, DependencyResolver resolver, @NotNull final Log log) throws IOException, ConfigurationException {
         Path propertiesPath = null;
         if (!Constants.META_INF.equals(generatedMetaInfRootDirectory.getName())) {
             throw new IllegalArgumentException("The workDir must end with 'META-INF' but is '" + generatedMetaInfRootDirectory+"'");
@@ -123,4 +122,4 @@ public class DirectoryValidationContext
         return null;
     }
 
-}
\ No newline at end of file
+}