This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-ear-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new b4970df Follow Oracle Javadoc guidelines (#472)
b4970df is described below
commit b4970dff149036cf6fcae29874274258099c1b8b
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Sat Sep 13 09:22:20 2025 -0400
Follow Oracle Javadoc guidelines (#472)
---
.../org/apache/maven/plugins/ear/AbstractEarModule.java | 14 ++++++++------
.../java/org/apache/maven/plugins/ear/AbstractEarMojo.java | 6 ++++--
.../maven/plugins/ear/ApplicationXmlWriterContext.java | 2 +-
.../org/apache/maven/plugins/ear/EarExecutionContext.java | 6 +++---
src/main/java/org/apache/maven/plugins/ear/EarModule.java | 6 +++---
.../org/apache/maven/plugins/ear/EarModuleFactory.java | 2 +-
src/main/java/org/apache/maven/plugins/ear/EarMojo.java | 8 +++++---
.../org/apache/maven/plugins/ear/EarPluginException.java | 7 ++-----
.../java/org/apache/maven/plugins/ear/EjbClientModule.java | 2 +-
src/main/java/org/apache/maven/plugins/ear/EjbRef.java | 8 ++++----
.../maven/plugins/ear/GenerateApplicationXmlMojo.java | 8 ++++----
src/main/java/org/apache/maven/plugins/ear/JarModule.java | 4 ++--
.../org/apache/maven/plugins/ear/JbossAppXmlWriter.java | 2 +-
.../org/apache/maven/plugins/ear/JbossConfiguration.java | 2 +-
.../java/org/apache/maven/plugins/ear/ResourceRef.java | 8 ++++----
src/main/java/org/apache/maven/plugins/ear/SarModule.java | 1 -
.../maven/plugins/ear/UnknownArtifactTypeException.java | 5 +----
.../maven/plugins/ear/util/ArtifactTypeMappingService.java | 2 +-
.../apache/maven/plugins/ear/util/EarMavenArchiver.java | 10 ++++++----
.../maven/plugins/ear/util/InvalidJavaEEVersion.java | 11 ++++-------
.../org/apache/maven/plugins/ear/util/JavaEEVersion.java | 8 +++++---
21 files changed, 61 insertions(+), 61 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
b/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
index 7178dfd..e3e5844 100644
--- a/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
@@ -58,7 +58,7 @@ public abstract class AbstractEarModule implements EarModule {
private String artifactId;
/**
- * The type of the artifact
+ * The type of the artifact.
*/
protected String type;
@@ -75,14 +75,14 @@ public abstract class AbstractEarModule implements
EarModule {
protected String bundleFileName;
/**
- * excluded by default {@code false}.
+ * Excluded by default {@code false}.
*/
protected Boolean excluded = Boolean.FALSE;
private String uri;
/**
- * unpack
+ * Unpack.
*/
protected Boolean unpack = null;
@@ -144,7 +144,9 @@ public abstract class AbstractEarModule implements
EarModule {
this.earExecutionContext = earExecutionContext;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void resolveArtifact(Set<Artifact> artifacts) throws
EarPluginException, MojoFailureException {
// If the artifact is already set no need to resolve it
if (artifact == null) {
@@ -183,7 +185,7 @@ public abstract class AbstractEarModule implements
EarModule {
}
/**
- * @return Return the URI.
+ * @return return the URI
*/
public String getUri() {
if (uri == null) {
@@ -318,7 +320,7 @@ public abstract class AbstractEarModule implements
EarModule {
/**
* Starts a new {@link #MODULE_ELEMENT} on the specified writer, possibly
including an id attribute.
*
- * @param writer the XML writer.
+ * @param writer the XML writer
* @param generateId whether an id should be generated
*/
protected void startModuleElement(XMLWriter writer, Boolean generateId) {
diff --git a/src/main/java/org/apache/maven/plugins/ear/AbstractEarMojo.java
b/src/main/java/org/apache/maven/plugins/ear/AbstractEarMojo.java
index 9c2bbd4..f0996b5 100644
--- a/src/main/java/org/apache/maven/plugins/ear/AbstractEarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/ear/AbstractEarMojo.java
@@ -103,7 +103,7 @@ public abstract class AbstractEarMojo extends AbstractMojo {
protected String defaultLibBundleDir;
/**
- * Should libraries be added in application.xml
+ * Should libraries be added in application.xml.
*/
@Parameter(defaultValue = "false")
private Boolean includeLibInApplicationXml = Boolean.FALSE;
@@ -157,7 +157,9 @@ public abstract class AbstractEarMojo extends AbstractMojo {
private JbossConfiguration jbossConfiguration;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if (fileNameMapping != null) {
diff --git
a/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriterContext.java
b/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriterContext.java
index a8e5b19..f9fe96a 100644
---
a/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriterContext.java
+++
b/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriterContext.java
@@ -134,7 +134,7 @@ class ApplicationXmlWriterContext {
/**
* Returns the list of {@link ResourceRef}.
*
- * @return the resource-ref elements.
+ * @return the resource-ref elements
*/
public List<ResourceRef> getResourceRefs() {
return resourceRefs;
diff --git
a/src/main/java/org/apache/maven/plugins/ear/EarExecutionContext.java
b/src/main/java/org/apache/maven/plugins/ear/EarExecutionContext.java
index c2268a7..e8ed849 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarExecutionContext.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarExecutionContext.java
@@ -38,10 +38,10 @@ public class EarExecutionContext {
/**
* @param project {@link MavenProject}
- * @param mainArtifactId The artifactId.
- * @param defaultLibBundleDir The defaultLibBundleDir.
+ * @param mainArtifactId the artifactId
+ * @param defaultLibBundleDir the defaultLibBundleDir
* @param jbossConfiguration {@link JbossConfiguration}
- * @param fileNameMappingName file name mapping.
+ * @param fileNameMappingName file name mapping
* @param typeMappingService {@link ArtifactTypeMappingService}
*/
public EarExecutionContext(
diff --git a/src/main/java/org/apache/maven/plugins/ear/EarModule.java
b/src/main/java/org/apache/maven/plugins/ear/EarModule.java
index 95bf336..3ab6208 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarModule.java
@@ -101,17 +101,17 @@ public interface EarModule {
void resolveArtifact(Set<Artifact> artifacts) throws EarPluginException,
MojoFailureException;
/**
- * @param earExecutionContext The execution context.
+ * @param earExecutionContext the execution context
*/
void setEarExecutionContext(EarExecutionContext earExecutionContext);
/**
- * @return the state if manifest classpath will be changed or not.
+ * @return the state if manifest classpath will be changed or not
*/
boolean changeManifestClasspath();
/**
- * @return The directory of the module which contains the JAR libraries
packaged within the module.
+ * @return the directory of the module which contains the JAR libraries
packaged within the module.
* Can be {@code null}, which means that module doesn't contain any
packaged libraries.
*/
String getLibDir();
diff --git a/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
b/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
index 5b9497e..5b35af3 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
@@ -65,7 +65,7 @@ public final class EarModuleFactory {
* @param defaultLibBundleDir the default bundle dir for {@link
org.apache.maven.plugins.ear.JarModule}
* @param includeInApplicationXml should {@link
org.apache.maven.plugins.ear.JarModule} be included in application
* Xml
- * @param typeMappingService The artifact type mapping service
+ * @param typeMappingService the artifact type mapping service
* @return an ear module for this artifact
* @throws UnknownArtifactTypeException if the artifact is not handled
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/EarMojo.java
b/src/main/java/org/apache/maven/plugins/ear/EarMojo.java
index 09124cb..576a009 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarMojo.java
@@ -297,7 +297,9 @@ public class EarMojo extends AbstractEarMojo {
this.mavenResourcesFiltering = mavenResourcesFiltering;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
// Initializes ear modules
@@ -510,7 +512,7 @@ public class EarMojo extends AbstractEarMojo {
}
/**
- * @return The array with the packaging excludes.
+ * @return the array with the packaging excludes
*/
public String[] getPackagingExcludes() {
if (packagingExcludes == null || packagingExcludes.isEmpty()) {
@@ -593,8 +595,8 @@ public class EarMojo extends AbstractEarMojo {
* @param destDir where to put the unpacked files
* @param outdatedResources currently outdated resources
* @throws ArchiverException a corrupt archive
- * @throws NoSuchArchiverException if we don't have an appropriate archiver
* @throws IOException in case of a general IOException
+ * @throws NoSuchArchiverException if we don't have an appropriate archiver
*/
public void unpack(File source, final File destDir, final
Collection<String> outdatedResources)
throws ArchiverException, NoSuchArchiverException, IOException {
diff --git a/src/main/java/org/apache/maven/plugins/ear/EarPluginException.java
b/src/main/java/org/apache/maven/plugins/ear/EarPluginException.java
index 7961b68..0e4c11c 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarPluginException.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarPluginException.java
@@ -25,9 +25,6 @@ package org.apache.maven.plugins.ear;
*/
public class EarPluginException extends Exception {
- /**
- *
- */
private static final long serialVersionUID = -5540929953103327928L;
/**
@@ -36,7 +33,7 @@ public class EarPluginException extends Exception {
public EarPluginException() {}
/**
- * @param message The message for the exception.
+ * @param message the message for the exception
*/
public EarPluginException(String message) {
super(message);
@@ -50,7 +47,7 @@ public class EarPluginException extends Exception {
}
/**
- * @param message The message to emit.
+ * @param message the message to emit
* @param cause {@link Throwable}
*/
public EarPluginException(String message, Throwable cause) {
diff --git a/src/main/java/org/apache/maven/plugins/ear/EjbClientModule.java
b/src/main/java/org/apache/maven/plugins/ear/EjbClientModule.java
index 45aa596..c381b5c 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EjbClientModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EjbClientModule.java
@@ -40,7 +40,7 @@ public class EjbClientModule extends JarModule {
/**
* @param a {@link Artifact}
- * @param defaultLibBundleDir The default lib bundle directory.
+ * @param defaultLibBundleDir the default lib bundle directory
*/
public EjbClientModule(Artifact a, String defaultLibBundleDir) {
super(a, defaultLibBundleDir, Boolean.FALSE);
diff --git a/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
b/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
index 84ca1de..8cf1148 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
@@ -46,10 +46,10 @@ public class EjbRef {
private String lookupName;
/**
- * @param description The ejb-ref description.
- * @param name The ejb-ref-name.
- * @param type The ejb-ref-type
- * @param lookupName The lookupname.
+ * @param description the ejb-ref description
+ * @param name the ejb-ref-name
+ * @param type the ejb-ref-type
+ * @param lookupName the lookupname
*/
public EjbRef(String description, String name, String type, String
lookupName) {
if (name == null || name.isEmpty()) {
diff --git
a/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
b/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
index f772f0c..4b59f59 100644
--- a/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
+++ b/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
@@ -296,10 +296,10 @@ public class GenerateApplicationXmlMojo extends
AbstractEarMojo {
* This help method was needed otherwise the interpolate method of
interpolator will make an empty string of a
* {@code null} element which results in supplemental elements for
env-entry.
*
- * @param interpolator The interpolator
- * @param element The element
- * @return The interpolated elements.
- * @throws InterpolationException in case of an error.
+ * @param interpolator the interpolator
+ * @param element the element
+ * @return the interpolated elements
+ * @throws InterpolationException in case of an error
*/
private String interpolate(Interpolator interpolator, String element)
throws InterpolationException {
if (element == null) {
diff --git a/src/main/java/org/apache/maven/plugins/ear/JarModule.java
b/src/main/java/org/apache/maven/plugins/ear/JarModule.java
index 080f9f4..b9c373f 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JarModule.java
@@ -52,8 +52,8 @@ public class JarModule extends AbstractEarModule {
/**
* @param a {@link Artifact}
- * @param defaultLibBundleDir The default library bundle directory.
- * @param includeInApplicationXml Include the application xml or not.
+ * @param defaultLibBundleDir the default library bundle directory
+ * @param includeInApplicationXml include the application xml or not
*/
public JarModule(Artifact a, String defaultLibBundleDir, Boolean
includeInApplicationXml) {
super(a);
diff --git a/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
b/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
index 2f2974c..f75a2cd 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
@@ -26,7 +26,7 @@ import java.util.List;
import org.codehaus.plexus.util.xml.XMLWriter;
/**
- * An {@code XmlWriter} based implementation used to generate a {@code
jboss-app.xml} file
+ * An {@code XmlWriter} based implementation used to generate a {@code
jboss-app.xml} file.
*
* @author <a href="[email protected]">Stephane Nicoll</a>
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
b/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
index 4b744ab..65c89c2 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
@@ -21,7 +21,7 @@ package org.apache.maven.plugins.ear;
import java.util.List;
/**
- * The JBoss specific configuration, used to generate the jboss-app.xml
deployment descriptor file
+ * The JBoss specific configuration, used to generate the jboss-app.xml
deployment descriptor file.
*
* @author <a href="[email protected]">Stephane Nicoll</a>
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
b/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
index 0ff3c61..4dde094 100644
--- a/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
+++ b/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
@@ -62,10 +62,10 @@ public class ResourceRef {
private String lookupName;
/**
- * @param name The res-ref-name.
- * @param type The res-type
- * @param auth The res-auth.
- * @param lookupName The lookup-name.
+ * @param name the res-ref-name
+ * @param type the res-type
+ * @param auth the res-auth
+ * @param lookupName the lookup-name
*/
public ResourceRef(String name, String type, String auth, String
lookupName) {
if (name == null || name.isEmpty()) {
diff --git a/src/main/java/org/apache/maven/plugins/ear/SarModule.java
b/src/main/java/org/apache/maven/plugins/ear/SarModule.java
index b5d42ce..085556e 100644
--- a/src/main/java/org/apache/maven/plugins/ear/SarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/SarModule.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.util.xml.XMLWriter;
*/
/**
* @author kama
- *
*/
public class SarModule extends AbstractEarModule implements JbossEarModule {
/**
diff --git
a/src/main/java/org/apache/maven/plugins/ear/UnknownArtifactTypeException.java
b/src/main/java/org/apache/maven/plugins/ear/UnknownArtifactTypeException.java
index ebdd354..436d12c 100644
---
a/src/main/java/org/apache/maven/plugins/ear/UnknownArtifactTypeException.java
+++
b/src/main/java/org/apache/maven/plugins/ear/UnknownArtifactTypeException.java
@@ -25,9 +25,6 @@ package org.apache.maven.plugins.ear;
*/
public class UnknownArtifactTypeException extends EarPluginException {
- /**
- *
- */
private static final long serialVersionUID = 2738931967722457793L;
/**
@@ -36,7 +33,7 @@ public class UnknownArtifactTypeException extends
EarPluginException {
public UnknownArtifactTypeException() {}
/**
- * @param message The message of the problem.
+ * @param message the message of the problem
*/
public UnknownArtifactTypeException(String message) {
super(message);
diff --git
a/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
b/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
index ee71d05..1d8b81e 100644
---
a/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
+++
b/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
@@ -119,7 +119,7 @@ public class ArtifactTypeMappingService {
*
* @param type a type
* @return the standard type (ejb, jar, war, ...) for this type
- * @throws UnknownArtifactTypeException In case of missing mappings types.
+ * @throws UnknownArtifactTypeException in case of missing mappings types
*/
public String getStandardType(final String type) throws
UnknownArtifactTypeException {
if (type == null) {
diff --git
a/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
b/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
index f37be0b..45c8062 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
@@ -56,9 +56,9 @@ public class EarMavenArchiver extends MavenArchiver {
/**
* @param project {@link MavenProject}
* @param config {@link MavenArchiveConfiguration}
+ * @return manifest
+ * @throws DependencyResolutionRequiredException in case of an resolution
error
* @throws ManifestException in case of an error
- * @throws DependencyResolutionRequiredException in case of an resolution
error.
- * @return Manifest
* @deprecated
*/
public Manifest getManifest(MavenProject project,
MavenArchiveConfiguration config)
@@ -66,7 +66,9 @@ public class EarMavenArchiver extends MavenArchiver {
return this.getManifest(null, project, config);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public Manifest getManifest(MavenSession session, MavenProject project,
MavenArchiveConfiguration config)
throws ManifestException, DependencyResolutionRequiredException {
final Manifest manifest = super.getManifest(session, project, config);
@@ -110,7 +112,7 @@ public class EarMavenArchiver extends MavenArchiver {
/**
* @param config {@link MavenArchiveConfiguration}
- * @return The class path entry.
+ * @return the class path entry
*/
protected String getUserSuppliedClassPathEntry(MavenArchiveConfiguration
config) {
if (config.getManifestEntries() != null) {
diff --git
a/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
b/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
index e0eeaa9..96b68a1 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
@@ -25,19 +25,16 @@ import org.apache.maven.plugin.MojoExecutionException;
*/
public class InvalidJavaEEVersion extends MojoExecutionException {
- /**
- *
- */
private static final long serialVersionUID = 3189028517550801372L;
/**
- * The invalid version
+ * The invalid version.
*/
private final String invalidVersion;
/**
- * @param message The message for the error
- * @param invalidVersion The invalid version.
+ * @param message the message for the error
+ * @param invalidVersion the invalid version
*/
public InvalidJavaEEVersion(String message, String invalidVersion) {
super(message);
@@ -45,7 +42,7 @@ public class InvalidJavaEEVersion extends
MojoExecutionException {
}
/**
- * @return The invalid version.
+ * @return the invalid version
*/
public String getInvalidVersion() {
return invalidVersion;
diff --git a/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
b/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
index d668071..f92281e 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
@@ -106,9 +106,9 @@ public class JavaEEVersion implements
Comparable<JavaEEVersion> {
}
/**
- * @param paramVersion The version.
+ * @param paramVersion the version
* @return {@link JavaEEVersion}
- * @throws InvalidJavaEEVersion in case of a wrong version.
+ * @throws InvalidJavaEEVersion in case of a wrong version
*/
public static JavaEEVersion getJavaEEVersion(String paramVersion) throws
InvalidJavaEEVersion {
if (!isValid(paramVersion)) {
@@ -199,7 +199,9 @@ public class JavaEEVersion implements
Comparable<JavaEEVersion> {
// @formatter:on
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public int compareTo(JavaEEVersion otherVersion) {
if (otherVersion == null) {
throw new NullPointerException("other object to compare to could
not be null.");
