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 2022/12/08 13:33:44 UTC
[jackrabbit-filevault-package-maven-plugin] branch master updated: releng: add missing null annotations
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 6ba09e1 releng: add missing null annotations
6ba09e1 is described below
commit 6ba09e148f6c5b5f736168ee4f494f510f8ac7ef
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Thu Dec 8 14:33:38 2022 +0100
releng: add missing null annotations
---
.../maven/packaging/ValidatorSettings.java | 5 ++--
.../packaging/impl/DirectoryValidationContext.java | 30 ++++++++++++----------
.../impl/PlexusIoNonExistingDirectoryResource.java | 3 ++-
.../maven/packaging/mojo/ValidateFilesMojo.java | 11 ++++++--
4 files changed, 30 insertions(+), 19 deletions(-)
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.java
index 0302995..11d848c 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.java
@@ -22,6 +22,7 @@ import java.util.Objects;
import org.apache.jackrabbit.vault.packaging.PackageId;
import org.apache.jackrabbit.vault.validation.spi.ValidationMessageSeverity;
+import org.jetbrains.annotations.NotNull;
/**
* Mutable implementation of org.apache.jackrabbit.vault.validation.spi.ValidatorSettings. Used as Mojo parameter type.
@@ -72,12 +73,12 @@ public class ValidatorSettings implements org.apache.jackrabbit.vault.validation
}
@Override
- public ValidationMessageSeverity getDefaultSeverity() {
+ public @NotNull ValidationMessageSeverity getDefaultSeverity() {
return defaultSeverity != null ? defaultSeverity : ValidationMessageSeverity.ERROR;
}
@Override
- public Map<String, String> getOptions() {
+ public @NotNull Map<String, String> getOptions() {
return options;
}
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DirectoryValidationContext.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DirectoryValidationContext.java
index b31b700..7def6f2 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DirectoryValidationContext.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DirectoryValidationContext.java
@@ -16,7 +16,6 @@
*/
package org.apache.jackrabbit.filevault.maven.packaging.impl;
-import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
@@ -48,22 +47,24 @@ public class DirectoryValidationContext implements ValidationContext {
private final DefaultWorkspaceFilter filter;
private Collection<PackageInfo> resolvedDependencies;
private final boolean isIncremental;
+ private final @NotNull Path packageRootDirectory;
private static final Path RELATIVE_PROPERTIES_XML_PATH = Paths.get(Constants.VAULT_DIR, Constants.PROPERTIES_XML);
- public DirectoryValidationContext(boolean isIncremental, @NotNull final File generatedMetaInfRootDirectory, final File metaInfRootDirectory, DependencyResolver resolver, @NotNull final Log log) throws IOException, ConfigurationException {
+ public DirectoryValidationContext(boolean isIncremental, @NotNull final Path generatedMetaInfRootDirectory, final Path metaInfRootDirectory,
+ @NotNull final Path packageRootDirectory, DependencyResolver resolver, @NotNull final Log log) throws IOException, ConfigurationException {
Path propertiesPath = null;
- if (!Constants.META_INF.equals(generatedMetaInfRootDirectory.getName())) {
+ if (!Constants.META_INF.equals(generatedMetaInfRootDirectory.getFileName().toString())) {
throw new IllegalArgumentException("The workDir must end with 'META-INF' but is '" + generatedMetaInfRootDirectory+"'");
}
if (metaInfRootDirectory != null) {
- if (!Constants.META_INF.equals(metaInfRootDirectory.getName())) {
+ if (!Constants.META_INF.equals(metaInfRootDirectory.getFileName().toString())) {
throw new IllegalArgumentException("The metaInfRootDirectory must end with 'META-INF' but is '" + metaInfRootDirectory+"'");
}
- propertiesPath = metaInfRootDirectory.toPath().resolve(Constants.VAULT_DIR).resolve(Constants.PROPERTIES_XML);
+ propertiesPath = metaInfRootDirectory.resolve(Constants.VAULT_DIR).resolve(Constants.PROPERTIES_XML);
}
if (propertiesPath == null || !Files.exists(propertiesPath)) {
- propertiesPath = generatedMetaInfRootDirectory.toPath().resolve(RELATIVE_PROPERTIES_XML_PATH);
+ propertiesPath = generatedMetaInfRootDirectory.resolve(RELATIVE_PROPERTIES_XML_PATH);
if (!Files.exists(propertiesPath)) {
throw new IllegalStateException("No '" + RELATIVE_PROPERTIES_XML_PATH + "' found in either '" +metaInfRootDirectory + "' or '" + generatedMetaInfRootDirectory + "'");
}
@@ -75,23 +76,24 @@ public class DirectoryValidationContext implements ValidationContext {
// filter always comes from the workDir
filter = new DefaultWorkspaceFilter();
- File filterFile = new File(generatedMetaInfRootDirectory, Constants.VAULT_DIR +"/"+Constants.FILTER_XML);
- if (!filterFile.exists()) {
+ Path filterFile = generatedMetaInfRootDirectory.resolve(Paths.get(Constants.VAULT_DIR, Constants.FILTER_XML));
+ if (!Files.isRegularFile(filterFile)) {
throw new IllegalStateException("No mandatory '" + Constants.VAULT_DIR +"/"+Constants.FILTER_XML + "' found in " + generatedMetaInfRootDirectory + "'");
}
- filter.load(filterFile);
+ filter.load(filterFile.toFile());
this.resolvedDependencies = resolver.resolvePackageInfo(getProperties().getDependencies(), getProperties().getDependenciesLocations());
this.isIncremental = isIncremental;
+ this.packageRootDirectory = packageRootDirectory;
}
@Override
- public PackageProperties getProperties() {
+ public @NotNull PackageProperties getProperties() {
return properties;
}
@Override
- public WorkspaceFilter getFilter() {
+ public @NotNull WorkspaceFilter getFilter() {
return filter;
}
@@ -101,12 +103,12 @@ public class DirectoryValidationContext implements ValidationContext {
}
@Override
- public Path getPackageRootPath() {
- return null;
+ public @NotNull Path getPackageRootPath() {
+ return packageRootDirectory;
}
@Override
- public Collection<PackageInfo> getDependenciesPackageInfo() {
+ public @NotNull Collection<PackageInfo> getDependenciesPackageInfo() {
return resolvedDependencies;
}
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PlexusIoNonExistingDirectoryResource.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PlexusIoNonExistingDirectoryResource.java
index 94193f9..fb9e70b 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PlexusIoNonExistingDirectoryResource.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PlexusIoNonExistingDirectoryResource.java
@@ -21,6 +21,7 @@ import java.io.InputStream;
import java.net.URL;
import org.codehaus.plexus.components.io.resources.AbstractPlexusIoResource;
+import org.jetbrains.annotations.NotNull;
public class PlexusIoNonExistingDirectoryResource extends AbstractPlexusIoResource {
@@ -30,7 +31,7 @@ public class PlexusIoNonExistingDirectoryResource extends AbstractPlexusIoResour
}
@Override
- public InputStream getContents() throws IOException {
+ public @NotNull InputStream getContents() throws IOException {
throw new UnsupportedOperationException("The underlying folder does not exist!");
}
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java
index 3e98b60..d1554e7 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java
@@ -197,7 +197,15 @@ public class ValidateFilesMojo extends AbstractValidateMojo {
}
File generatedMetaInfRootDirectory = new File(AbstractMetadataPackageMojo.getWorkDirectory(getLog(), false, workDirectory, classifier), Constants.META_INF);
getLog().info("Validate files in generatedMetaInfRootDirectory " + getProjectRelativeFilePath(generatedMetaInfRootDirectory.toPath()) + " and metaInfRootDir " + getProjectRelativeFilePath(generatedMetaInfRootDirectory.toPath()));
- ValidationContext context = new DirectoryValidationContext(buildContext.isIncremental(), generatedMetaInfRootDirectory, metaInfRootDirectory, resolver, getLog());
+ File jcrSourceDirectory = AbstractSourceAndMetadataPackageMojo.getJcrSourceDirectory(jcrRootSourceDirectory, builtContentDirectory, getLog());
+ final Path packageRootDirectory;
+ if (jcrSourceDirectory != null) {
+ // just return path of non-existing directory
+ packageRootDirectory = jcrRootSourceDirectory[0].toPath().getParent();
+ } else {
+ packageRootDirectory = jcrSourceDirectory.getParentFile().toPath();
+ }
+ ValidationContext context = new DirectoryValidationContext(buildContext.isIncremental(), generatedMetaInfRootDirectory.toPath(), metaInfRootDirectory.toPath(), packageRootDirectory, resolver, getLog());
ValidationExecutor executor = validationExecutorFactory.createValidationExecutor(context, false, false, getEffectiveValidatorSettingsForPackage(context.getProperties().getId(), false));
if (executor == null) {
throw new MojoExecutionException("No registered validators found!");
@@ -207,7 +215,6 @@ public class ValidateFilesMojo extends AbstractValidateMojo {
validateDirectoryRecursively(validationHelper, executor, metaInfRootDirectory.toPath(), true);
}
validateDirectoryRecursively(validationHelper, executor, generatedMetaInfRootDirectory.toPath(), true);
- File jcrSourceDirectory = AbstractSourceAndMetadataPackageMojo.getJcrSourceDirectory(jcrRootSourceDirectory, builtContentDirectory, getLog());
if (jcrSourceDirectory != null) {
validateDirectoryRecursively(validationHelper, executor, jcrSourceDirectory.toPath(), false);
}