This is an automated email from the ASF dual-hosted git repository. elharo pushed a commit to branch fix in repository https://gitbox.apache.org/repos/asf/maven-war-plugin.git
commit 8bdd8a2e866fcad28c8b8edc434a72fb1cc6a659 Author: Elliotte Rusty Harold <[email protected]> AuthorDate: Thu Oct 23 08:20:55 2025 -0400 Fix Javadoc issues per Oracle conventions --- .../apache/maven/plugins/war/AbstractWarMojo.java | 68 +++++++++++----------- .../java/org/apache/maven/plugins/war/Overlay.java | 8 +-- .../java/org/apache/maven/plugins/war/WarMojo.java | 29 +++++---- .../InvalidOverlayConfigurationException.java | 7 +-- .../war/packaging/AbstractWarPackagingTask.java | 26 ++++----- .../war/packaging/ArtifactsPackagingTask.java | 2 +- .../war/packaging/ClassesPackagingTask.java | 4 +- .../war/packaging/CopyUserManifestTask.java | 7 +-- .../war/packaging/OverlayPackagingTask.java | 2 +- .../plugins/war/packaging/WarPackagingContext.java | 14 ++--- .../war/packaging/WarProjectPackagingTask.java | 2 +- .../maven/plugins/war/util/ClassesPackager.java | 2 +- .../org/apache/maven/plugins/war/util/PathSet.java | 32 +++++----- .../apache/maven/plugins/war/util/WarUtils.java | 2 +- .../maven/plugins/war/util/WebappStructure.java | 2 +- 15 files changed, 100 insertions(+), 107 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java b/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java index 434ed37..5c14fd7 100644 --- a/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java +++ b/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java @@ -217,7 +217,6 @@ public abstract class AbstractWarMojo extends AbstractMojo { /** * The comma separated list of tokens to include when doing a WAR overlay. Default is * {@link org.apache.maven.plugins.war.Overlay#DEFAULT_INCLUDES} - * */ @Parameter private String dependentWarIncludes = StringUtils.join(Overlay.DEFAULT_INCLUDES, ","); @@ -225,7 +224,6 @@ public abstract class AbstractWarMojo extends AbstractMojo { /** * The comma separated list of tokens to exclude when doing a WAR overlay. Default is * {@link org.apache.maven.plugins.war.Overlay#DEFAULT_EXCLUDES} - * */ @Parameter private String dependentWarExcludes = StringUtils.join(Overlay.DEFAULT_EXCLUDES, ","); @@ -327,7 +325,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { private boolean includeEmptyDirectories; /** - * Stop searching endToken at the end of line + * Stop searching endToken at the end of line. * * @since 2.4 */ @@ -335,7 +333,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { private boolean supportMultiLineFiltering; /** - * use jvmChmod rather that cli chmod and forking process + * Use jvmChmod rather that cli chmod and forking process. * * @since 2.4 */ @@ -402,7 +400,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return The current overlay. + * @return the current overlay */ public Overlay getCurrentProjectOverlay() { return currentProjectOverlay; @@ -460,9 +458,9 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @param webapplicationDirectory The web application directory. - * @throws MojoExecutionException In case of failure. - * @throws MojoFailureException In case of failure. + * @param webapplicationDirectory the web application directory + * @throws MojoExecutionException in case of failure + * @throws MojoFailureException in case of failure */ public void buildExplodedWebapp(File webapplicationDirectory) throws MojoExecutionException, MojoFailureException { webapplicationDirectory.mkdirs(); @@ -480,9 +478,9 @@ public abstract class AbstractWarMojo extends AbstractMojo { * * @param mavenProject the maven project * @param webapplicationDirectory the target directory + * @throws IOException if an error occurred while copying the files * @throws MojoExecutionException if an error occurred while packaging the webapp * @throws MojoFailureException if an unexpected error occurred while packaging the webapp - * @throws IOException if an error occurred while copying the files */ public void buildWebapp(MavenProject mavenProject, File webapplicationDirectory) throws MojoExecutionException, MojoFailureException, IOException { @@ -575,7 +573,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * WarPackagingContext default implementation + * WarPackagingContext default implementation. */ private class DefaultWarPackagingContext implements WarPackagingContext { private final ArtifactFactory artifactFactory; @@ -605,17 +603,17 @@ public abstract class AbstractWarMojo extends AbstractMojo { private final String outputTimestamp; /** - * @param webappDirectory The web application directory. - * @param webappStructure The web app structure. - * @param overlayManager The overlay manager. - * @param filterWrappers The filter wrappers - * @param nonFilteredFileExtensions The non filtered file extensions. - * @param filteringDeploymentDescriptors The filtering deployment descriptors. - * @param artifactFactory The artifact factory. - * @param resourceEncoding The resource encoding. - * @param propertiesEncoding The encoding to use for properties files. - * @param useJvmChmod use Jvm chmod or not. - * @param failOnMissingWebXml Flag to check whether we should ignore missing web.xml or not + * @param webappDirectory the web application directory + * @param webappStructure the web app structure + * @param overlayManager the overlay manager + * @param filterWrappers the filter wrappers + * @param nonFilteredFileExtensions the non filtered file extensions + * @param filteringDeploymentDescriptors the filtering deployment descriptors + * @param artifactFactory the artifact factory + * @param resourceEncoding the resource encoding + * @param propertiesEncoding the encoding to use for properties files + * @param useJvmChmod use Jvm chmod or not + * @param failOnMissingWebXml flag to check whether we should ignore missing web.xml or not * @param outputTimestamp the output timestamp for reproducible archive creation */ @SuppressWarnings("checkstyle:ParameterNumber") @@ -848,7 +846,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return list of packaging excludes. + * @return list of packaging excludes * @since 3.4.1 */ @Override @@ -857,7 +855,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return list of packaging includes. + * @return list of packaging includes * @since 3.4.1 */ @Override @@ -867,28 +865,28 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return The Maven Project. + * @return the Maven Project */ public MavenProject getProject() { return project; } /** - * @param project The project to be set. + * @param project the project to be set */ public void setProject(MavenProject project) { this.project = project; } /** - * @return the classes directory. + * @return the classes directory */ public File getClassesDirectory() { return classesDirectory; } /** - * @param classesDirectory The classes directory to be set. + * @param classesDirectory the classes directory to be set */ public void setClassesDirectory(File classesDirectory) { this.classesDirectory = classesDirectory; @@ -902,7 +900,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @param webappDirectory The web application directory. + * @param webappDirectory the web application directory */ public void setWebappDirectory(File webappDirectory) { this.webappDirectory = webappDirectory; @@ -923,14 +921,14 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return The {@link #webXml} + * @return the {@link #webXml} */ public File getWebXml() { return webXml; } /** - * @param webXml The {@link #webXml} + * @param webXml the {@link #webXml} */ public void setWebXml(File webXml) { this.webXml = webXml; @@ -979,7 +977,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @param overlay add {@link #overlays}. + * @param overlay add {@link #overlays} */ public void addOverlay(Overlay overlay) { overlays.add(overlay); @@ -1000,14 +998,14 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return {@link #webResources}. + * @return {@link #webResources} */ public Resource[] getWebResources() { return webResources; } /** - * @param webResources {@link #webResources}. + * @param webResources {@link #webResources} */ public void setWebResources(Resource[] webResources) { this.webResources = webResources; @@ -1084,7 +1082,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return The package excludes. + * @return the package excludes */ public String[] getPackagingExcludes() { if (packagingExcludes == null || packagingExcludes.isEmpty()) { @@ -1102,7 +1100,7 @@ public abstract class AbstractWarMojo extends AbstractMojo { } /** - * @return The packaging includes. + * @return the packaging includes */ public String[] getPackagingIncludes() { if (packagingIncludes == null || packagingIncludes.isEmpty()) { diff --git a/src/main/java/org/apache/maven/plugins/war/Overlay.java b/src/main/java/org/apache/maven/plugins/war/Overlay.java index 9ad4b01..1330acc 100644 --- a/src/main/java/org/apache/maven/plugins/war/Overlay.java +++ b/src/main/java/org/apache/maven/plugins/war/Overlay.java @@ -69,7 +69,7 @@ public class Overlay { private String targetPath; - /** default overlay type is war */ + /** Default overlay type is war. */ private String type = "war"; /** @@ -99,7 +99,7 @@ public class Overlay { } /** - * @return {@link Overlay} instance. + * @return {@link Overlay} instance */ public static Overlay createInstance() { Overlay overlay = new Overlay(); @@ -110,7 +110,7 @@ public class Overlay { // Getters and Setters /** - * @return The id. + * @return the id */ public String getId() { if (id == null) { @@ -125,7 +125,7 @@ public class Overlay { } /** - * @param id The id. + * @param id the id */ public void setId(String id) { this.id = id; diff --git a/src/main/java/org/apache/maven/plugins/war/WarMojo.java b/src/main/java/org/apache/maven/plugins/war/WarMojo.java index 7d121aa..8d00a4b 100644 --- a/src/main/java/org/apache/maven/plugins/war/WarMojo.java +++ b/src/main/java/org/apache/maven/plugins/war/WarMojo.java @@ -88,8 +88,6 @@ public class WarMojo extends AbstractWarMojo { @Component(role = Archiver.class, hint = "war") private WarArchiver warArchiver; - /** - */ @Component private MavenProjectHelper projectHelper; @@ -160,7 +158,7 @@ public class WarMojo extends AbstractWarMojo { * Executes the WarMojo on the current project. * * @throws MojoExecutionException if an error occurred while building the webapp - * @throws MojoFailureException if an error. + * @throws MojoFailureException if an error */ @Override public void execute() throws MojoExecutionException, MojoFailureException { @@ -185,10 +183,10 @@ public class WarMojo extends AbstractWarMojo { * Generates the webapp according to the {@code mode} attribute. * * @param warFile the target WAR file - * @throws IOException if an error occurred while copying files * @throws ArchiverException if the archive could not be created - * @throws ManifestException if the manifest could not be created * @throws DependencyResolutionRequiredException if an error occurred while resolving the dependencies + * @throws IOException if an error occurred while copying files + * @throws ManifestException if the manifest could not be created * @throws MojoExecutionException if the execution failed * @throws MojoFailureException if a fatal exception occurred */ @@ -280,9 +278,9 @@ public class WarMojo extends AbstractWarMojo { * dependencies (which includes provided dependencies) of the Maven project. * * @return <code>true</code> if the project being built depends on Servlet 3.0 API or Jakarta Servlet API, - * <code>false</code> otherwise. - * @throws DependencyResolutionRequiredException if the compile elements can't be resolved. - * @throws MalformedURLException if the path to a dependency file can't be transformed to a URL. + * <code>false</code> otherwise + * @throws DependencyResolutionRequiredException if the compile elements can't be resolved + * @throws MalformedURLException if the path to a dependency file can't be transformed to a URL */ private boolean isProjectUsingAtLeastServlet30() throws DependencyResolutionRequiredException, MalformedURLException { @@ -318,10 +316,10 @@ public class WarMojo extends AbstractWarMojo { } /** - * @param basedir The basedir - * @param finalName The finalName - * @param classifier The classifier. - * @param type The type. + * @param basedir the basedir + * @param finalName the finalName + * @param classifier the classifier + * @param type the type * @return {@link File} */ protected static File getTargetFile(File basedir, String finalName, String classifier, String type) { @@ -335,14 +333,14 @@ public class WarMojo extends AbstractWarMojo { } /** - * @return The war {@link File} + * @return the war {@link File} */ protected File getTargetWarFile() { return getTargetFile(new File(getOutputDirectory()), getWarName(), getClassifier(), "war"); } /** - * @return The target class {@link File} + * @return the target class {@link File} */ protected File getTargetClassesFile() { return getTargetFile(new File(getOutputDirectory()), getWarName(), getClassesClassifier(), "jar"); @@ -477,7 +475,8 @@ public class WarMojo extends AbstractWarMojo { } /** - * Skip the mojo run + * Skip the mojo run. + * * @return {@link #skip} */ public boolean isSkip() { diff --git a/src/main/java/org/apache/maven/plugins/war/overlay/InvalidOverlayConfigurationException.java b/src/main/java/org/apache/maven/plugins/war/overlay/InvalidOverlayConfigurationException.java index e4b0ec5..138e191 100644 --- a/src/main/java/org/apache/maven/plugins/war/overlay/InvalidOverlayConfigurationException.java +++ b/src/main/java/org/apache/maven/plugins/war/overlay/InvalidOverlayConfigurationException.java @@ -27,20 +27,17 @@ import org.apache.maven.plugin.MojoExecutionException; */ public class InvalidOverlayConfigurationException extends MojoExecutionException { - /** - * - */ private static final long serialVersionUID = -9048144470408031414L; /** - * @param string Set the message of the exception. + * @param string set the message of the exception */ public InvalidOverlayConfigurationException(String string) { super(string); } /** - * @param string Set the message of the exception. + * @param string set the message of the exception * @param throwable {@link Throwable} */ public InvalidOverlayConfigurationException(String string, Throwable throwable) { diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java index cdce808..cb1a8de 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java @@ -78,16 +78,16 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * * If the structure of the source directory is not the same as the root of the webapp, use the {@code targetPrefix} * parameter to specify in which particular directory the files should be copied. Use {@code null} to copy the - * files with the same structure + * files with the same structure. * * @param sourceId the source id * @param context the context to use * @param sourceBaseDir the base directory from which the {@code sourceFilesSet} will be copied * @param sourceFilesSet the files to be copied * @param targetPrefix the prefix to add to the target file name - * @param filtered filter or not. + * @param filtered filter or not * @throws IOException if an error occurred while copying the files - * @throws MojoExecutionException if an error occurs. + * @throws MojoExecutionException if an error occurs */ protected void copyFiles( String sourceId, @@ -125,9 +125,9 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * @param context the context to use * @param sourceBaseDir the base directory from which the {@code sourceFilesSet} will be copied * @param sourceFilesSet the files to be copied - * @param filtered filter or not. + * @param filtered filter or not * @throws IOException if an error occurred while copying the files - * @throws MojoExecutionException break the build. + * @throws MojoExecutionException break the build */ protected void copyFiles( String sourceId, WarPackagingContext context, File sourceBaseDir, PathSet sourceFilesSet, boolean filtered) @@ -297,7 +297,7 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * * @param context the packaging context * @param source an existing non-directory <code>File</code> to copy bytes from - * @param destination a non-directory <code>File</code> to write bytes to (possibly overwriting). + * @param destination a non-directory <code>File</code> to write bytes to (possibly overwriting) * @param targetFilename the relative path of the file from the webapp root directory * @param onlyIfModified if true, copy the file only if the source has changed, always copy otherwise * @return true if the file has been copied/updated, false otherwise @@ -343,7 +343,7 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * Get the encoding from an XML-file. * * @param webXml the XML-file - * @return The encoding of the XML-file, or UTF-8 if it's not specified in the file + * @return the encoding of the XML-file, or UTF-8 if it's not specified in the file * @throws java.io.IOException if an error occurred while reading the file */ protected String getEncoding(File webXml) throws IOException { @@ -370,7 +370,7 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * @param baseDir the base directory to start from * @param includes the includes * @param excludes the excludes - * @param includeDirectories include directories yes or not. + * @param includeDirectories include directories yes or not * @return the files to copy */ // CHECKSTYLE_OFF: LineLength @@ -411,7 +411,7 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * @param context the packaging context * @param artifact the artifact * @return the converted filename of the artifact - * @throws InterpolationException in case of interpolation problem. + * @throws InterpolationException in case of interpolation problem */ protected String getArtifactFinalName(WarPackagingContext context, Artifact artifact) throws InterpolationException { @@ -430,8 +430,8 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { /** * Determine whether a file is of a certain type, by looking at the file extension. * - * @param file The file to check - * @param extension The extension for a file type, including the '.' + * @param file the file to check + * @param extension the extension for a file type, including the '.' * @return <code>true</code> if the file is a file of the specified type, otherwise <code>false</code> * @since 3.4.0 */ @@ -442,7 +442,7 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { /** * Determine whether a file is a properties file or not. * - * @param file The file to check + * @param file the file to check * @return <code>true</code> if the file is a properties file, otherwise <code>false</code> * @since 3.4.0 */ @@ -454,7 +454,7 @@ public abstract class AbstractWarPackagingTask implements WarPackagingTask { * Returns <code>true</code> if the <code>File</code>-object is a file (not a directory) that is not * <code>null</code> and has a file name that ends in ".xml". * - * @param file The file to check + * @param file the file to check * @return <code>true</code> if the file is an xml-file, otherwise <code>false</code> * @since 2.3 */ diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/ArtifactsPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/ArtifactsPackagingTask.java index 6b6755a..df33c7e 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/ArtifactsPackagingTask.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/ArtifactsPackagingTask.java @@ -135,7 +135,7 @@ public class ArtifactsPackagingTask extends AbstractWarPackagingTask { * * @param context the packaging context * @param artifacts set of artifacts - * @return List of duplicated artifacts as bundling file names + * @return list of duplicated artifacts as bundling file names */ private List<String> findDuplicates(WarPackagingContext context, Set<Artifact> artifacts) throws InterpolationException { diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java index 6f71048..07d17a3 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java @@ -80,8 +80,8 @@ public class ClassesPackagingTask extends AbstractWarPackagingTask { } /** - * @param context The warPackingContext. - * @throws MojoExecutionException In case of an error. + * @param context the warPackingContext + * @throws MojoExecutionException in case of an error */ protected void generateJarArchive(WarPackagingContext context) throws MojoExecutionException { MavenProject project = context.getProject(); diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java index 9b1be7a..fbee204 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java @@ -28,17 +28,16 @@ import org.apache.maven.plugin.logging.SystemStreamLog; /** * @author Haikal Saadh - * */ public class CopyUserManifestTask extends AbstractWarPackagingTask { - /** Instance logger */ + /** Instance logger. */ private Log log; /** - * Returns the logger. + * Returns the logger. * - * @return logger + * return logger. */ public Log getLog() { if (log == null) { diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/OverlayPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/OverlayPackagingTask.java index c46d9bb..e984992 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/OverlayPackagingTask.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/OverlayPackagingTask.java @@ -36,7 +36,7 @@ public class OverlayPackagingTask extends AbstractWarPackagingTask { /** * @param overlay {@link #overlay} - * @param currentProjectOverlay current overlay. + * @param currentProjectOverlay current overlay */ public OverlayPackagingTask(Overlay overlay, Overlay currentProjectOverlay) { if (overlay == null) { diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java b/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java index 9863711..09deea3 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java @@ -172,7 +172,7 @@ public interface WarPackagingContext { List<FilterWrapper> getFilterWrappers(); /** - * Specify if the given {@code fileName} belongs to the list of extensions that must not be filtered + * Specify if the given {@code fileName} belongs to the list of extensions that must not be filtered. * * @param fileName the name of file * @return {@code true} if it should not be filtered, {@code false} otherwise @@ -181,7 +181,7 @@ public interface WarPackagingContext { boolean isNonFilteredExtension(String fileName); /** - * @return filtering deployment descriptor. + * @return filtering deployment descriptor */ boolean isFilteringDeploymentDescriptors(); @@ -221,7 +221,7 @@ public interface WarPackagingContext { boolean isUseJvmChmod(); /** - * Returns the flag that switch on/off the missing web.xml validation + * Returns the flag that switch on/off the missing web.xml validation. * * @return failOnMissingWebXml */ @@ -234,8 +234,8 @@ public interface WarPackagingContext { * This prevent calling <code>mvn clean</code> when resources are removed. * * @param resource the resource that is to me marked as not outdated - * @since 3.3.0 * @see #deleteOutdatedResources() + * @since 3.3.0 */ void addResource(String resource); @@ -244,8 +244,8 @@ public interface WarPackagingContext { * packaging process, then are supposed to be content from a previous run. * This prevent calling <code>mvn clean</code> when resources are removed. * - * @since 3.3.0 * @see #addResource + * @since 3.3.0 */ void deleteOutdatedResources(); @@ -258,13 +258,13 @@ public interface WarPackagingContext { String getOutputTimestamp(); /** - * @return list of packaging excludes. + * @return list of packaging excludes * @since 3.4.1 */ List<String> getPackagingExcludes(); /** - * @return list of packaging includes. + * @return list of packaging includes * @since 3.4.1 */ List<String> getPackagingIncludes(); diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/WarProjectPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/WarProjectPackagingTask.java index f6a960d..b31076d 100644 --- a/src/main/java/org/apache/maven/plugins/war/packaging/WarProjectPackagingTask.java +++ b/src/main/java/org/apache/maven/plugins/war/packaging/WarProjectPackagingTask.java @@ -197,8 +197,8 @@ public class WarProjectPackagingTask extends AbstractWarPackagingTask { * @param webinfDir the web-inf directory * @param metainfDir the meta-inf directory * @param failOnMissingWebXml if build should fail if web.xml is not found - * @throws MojoFailureException if the web.xml is specified but does not exist and failOnMissingWebXml is true * @throws MojoExecutionException if an error occurred while copying the descriptors + * @throws MojoFailureException if the web.xml is specified but does not exist and failOnMissingWebXml is true */ protected void handleDeploymentDescriptors( WarPackagingContext context, File webinfDir, File metainfDir, Boolean failOnMissingWebXml) diff --git a/src/main/java/org/apache/maven/plugins/war/util/ClassesPackager.java b/src/main/java/org/apache/maven/plugins/war/util/ClassesPackager.java index 19c2c9b..5dc744d 100644 --- a/src/main/java/org/apache/maven/plugins/war/util/ClassesPackager.java +++ b/src/main/java/org/apache/maven/plugins/war/util/ClassesPackager.java @@ -40,7 +40,7 @@ import org.codehaus.plexus.archiver.jar.ManifestException; public class ClassesPackager { /** - * Package the classes + * Package the classes. * * @param classesDirectory the classes directory * @param targetFile the target file diff --git a/src/main/java/org/apache/maven/plugins/war/util/PathSet.java b/src/main/java/org/apache/maven/plugins/war/util/PathSet.java index 4d41418..08e9f78 100644 --- a/src/main/java/org/apache/maven/plugins/war/util/PathSet.java +++ b/src/main/java/org/apache/maven/plugins/war/util/PathSet.java @@ -39,7 +39,7 @@ public class PathSet implements Iterable<String> { private static final String SEPARATOR = "/"; private static final char SEPARATOR_CHAR = SEPARATOR.charAt(0); /** - * Set of normalized paths + * Set of normalized paths. */ private Set<String> pathsSet = new LinkedHashSet<>(); @@ -61,14 +61,14 @@ public class PathSet implements Iterable<String> { /*-------------------- Business interface ------------------------------*/ /** - * Creates an empty paths set + * Creates an empty paths set. */ public PathSet() { /* Empty default constructor */ } /** - * Creates paths set and normalizate and adds all 'paths'. The source 'paths' will not be changed + * Creates paths set and normalizate and adds all 'paths'. The source 'paths' will not be changed. * * @param paths to be added */ @@ -77,7 +77,7 @@ public class PathSet implements Iterable<String> { } /** - * Creates paths set and normalizate and adds all 'paths'. The source 'paths' will not be changed + * Creates paths set and normalizate and adds all 'paths'. The source 'paths' will not be changed. * * @param paths to be added */ @@ -95,9 +95,9 @@ public class PathSet implements Iterable<String> { } /** - * Normalizes and adds given paths (collection of strings) to the set. The source collection will not be changed + * Normalizes and adds given paths (collection of strings) to the set. The source collection will not be changed. * - * @param paths - collection of strings to be added + * @param paths collection of strings to be added * @param prefix added to all given paths */ public void addAll(Collection<String> paths, String prefix) { @@ -107,7 +107,7 @@ public class PathSet implements Iterable<String> { } /** - * Normalizes and adds given paths to the set. The source collection will not be changed + * Normalizes and adds given paths to the set. The source collection will not be changed. * * @param paths to be added * @param prefix added to all given paths @@ -119,7 +119,7 @@ public class PathSet implements Iterable<String> { } /** - * Adds given paths to the set. The source collection will not be changed + * Adds given paths to the set. The source collection will not be changed. * * @param paths to be added * @param prefix added to all given paths @@ -131,16 +131,16 @@ public class PathSet implements Iterable<String> { } /** - * Normalizes and adds given paths (collection of strings) to the set. The source collection will not be changed + * Normalizes and adds given paths (collection of strings) to the set. The source collection will not be changed. * - * @param paths - collection of strings to be added + * @param paths collection of strings to be added */ public void addAll(Collection<String> paths) { addAll(paths, ""); } /** - * Normalizes and adds given paths to the set. The source collection will not be changed + * Normalizes and adds given paths to the set. The source collection will not be changed. * * @param paths to be added */ @@ -149,7 +149,7 @@ public class PathSet implements Iterable<String> { } /** - * Adds given paths to the set. The source collection will not be changed + * Adds given paths to the set. The source collection will not be changed. * * @param paths to be added */ @@ -160,8 +160,8 @@ public class PathSet implements Iterable<String> { /** * Checks if the set constains given path. The path is normalized before check. * - * @param path we are looking for in the set. - * @return information if the set constains the path. + * @param path we are looking for in the set + * @return information if the set constains the path */ public boolean contains(String path) { return pathsSet.contains(normalizeSubPath(path)); @@ -210,7 +210,7 @@ public class PathSet implements Iterable<String> { } /** - * Returns count of the paths in the set + * Returns count of the paths in the set. * * @return count of the paths in the set */ @@ -219,7 +219,7 @@ public class PathSet implements Iterable<String> { } /** - * Adds to the set all files in the given directory + * Adds to the set all files in the given directory. * * @param directory that will be searched for file's paths to add * @param prefix to be added to all found files diff --git a/src/main/java/org/apache/maven/plugins/war/util/WarUtils.java b/src/main/java/org/apache/maven/plugins/war/util/WarUtils.java index a8313bd..54d83d1 100644 --- a/src/main/java/org/apache/maven/plugins/war/util/WarUtils.java +++ b/src/main/java/org/apache/maven/plugins/war/util/WarUtils.java @@ -53,7 +53,7 @@ public class WarUtils { /** * @param artifact {@link Artifact} * @param dependency {@link Dependency} - * @return is related or not. + * @return is related or not */ public static boolean isRelated(Artifact artifact, Dependency dependency) { if (artifact == null || dependency == null) { diff --git a/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java b/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java index e2cb735..c094534 100644 --- a/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java +++ b/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java @@ -168,7 +168,7 @@ public class WebappStructure { * Returns the owner of the specified {@code path}. If the file is not registered, returns {@code null} * * @param path the relative path from the webapp root directory - * @return the owner or {@code null}. + * @return the owner or {@code null} */ public String getOwner(String path) { if (!isRegistered(path)) {
