You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2018/03/07 21:04:18 UTC
[maven-ear-plugin] branch CLEANUP updated: Cleanup JavaDoc issues.
This is an automated email from the ASF dual-hosted git repository.
khmarbaise pushed a commit to branch CLEANUP
in repository https://gitbox.apache.org/repos/asf/maven-ear-plugin.git
The following commit(s) were added to refs/heads/CLEANUP by this push:
new f17e103 Cleanup JavaDoc issues.
f17e103 is described below
commit f17e1037f8f401d353c72f723a88860c6b3826d9
Author: Karl Heinz Marbaise <kh...@apache.org>
AuthorDate: Wed Mar 7 22:04:03 2018 +0100
Cleanup JavaDoc issues.
---
.../maven/plugins/ear/it/AbstractEarPluginIT.java | 12 +--
.../org/apache/maven/plugins/ear/it/EarMojoIT.java | 93 ++++++++++++++++++++--
2 files changed, 94 insertions(+), 11 deletions(-)
diff --git a/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java b/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java
index 0e6ef79..bda5a53 100644
--- a/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java
+++ b/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java
@@ -70,6 +70,7 @@ public abstract class AbstractEarPluginIT
*
* @param projectName the name of the project
* @param properties extra properties to be used by the embedder
+ * @param expectNoError true/flase.
* @return the base directory of the project
* @throws Exception if an error occurred
*/
@@ -133,7 +134,7 @@ public abstract class AbstractEarPluginIT
* @param artifactsDirectory whether the artifact is an exploded artifactsDirectory or not
* @param testDeploymentDescriptors whether we should test deployment descriptors
* @return the base directory of the project
- * @throws Exception
+ * @throws Exception Mojo exception in case of an error.
*/
protected File doTestProject( final String projectName, final String[] expectedArtifacts,
final boolean[] artifactsDirectory, boolean testDeploymentDescriptors )
@@ -161,7 +162,7 @@ public abstract class AbstractEarPluginIT
* @param expectedArtifacts the list of artifacts to be found in the EAR archive
* @param artifactsDirectory whether the artifact is an exploded artifactsDirectory or not
* @return the base directory of the project
- * @throws Exception
+ * @throws Exception Mojo exception in case of an error.
*/
protected File doTestProject( final String projectName, final String[] expectedArtifacts,
final boolean[] artifactsDirectory )
@@ -178,7 +179,7 @@ public abstract class AbstractEarPluginIT
* @param expectedArtifacts the list of artifacts to be found in the EAR archive
* @param testDeploymentDescriptors whether we should test deployment descriptors
* @return the base directory of the project
- * @throws Exception
+ * @throws Exception Mojo exception in case of an error.
*/
protected File doTestProject( final String projectName, final String[] expectedArtifacts,
boolean testDeploymentDescriptors )
@@ -194,7 +195,7 @@ public abstract class AbstractEarPluginIT
* @param projectName the project to test
* @param expectedArtifacts the list of artifacts to be found in the EAR archive
* @return the base directory of the project
- * @throws Exception
+ * @throws Exception Mojo exception in case of an error.
*/
protected File doTestProject( final String projectName, final String[] expectedArtifacts )
throws Exception
@@ -336,12 +337,13 @@ public abstract class AbstractEarPluginIT
/**
* Asserts that the deployment descriptors have been generated successfully.
- * <p/>
+ *
* This test assumes that deployment descriptors are located in the <tt>expected-META-INF</tt> directory of the
* project. Note that the <tt>MANIFEST.mf</tt> file is ignored and is not tested.
*
* @param baseDir the directory of the tested project
* @param projectName the name of the project
+ * @throws IOException exception in case of an error.
*/
protected void assertDeploymentDescriptors( final File baseDir, final String projectName )
throws IOException
diff --git a/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java b/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java
index 8a201de..a9dcb44 100644
--- a/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java
+++ b/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java
@@ -31,7 +31,6 @@ import org.codehaus.plexus.util.ReaderFactory;
/**
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
- * @noinspection JavaDoc
*/
public class EarMojoIT
extends AbstractEarPluginIT
@@ -39,6 +38,7 @@ public class EarMojoIT
/**
* Builds an EAR with a single EJB and no configuration.
+ * @throws Exception in case of an error.
*/
public void testProject001()
throws Exception
@@ -48,6 +48,7 @@ public class EarMojoIT
/**
* Builds an EAR with a customized artifact location and a customized artifact name.
+ * @throws Exception in case of an error.
*/
public void testProject002()
throws Exception
@@ -58,6 +59,7 @@ public class EarMojoIT
/**
* Builds an EAR with a default bundle directory for <tt>java</tt> modules.
+ * @throws Exception in case of an error.
*/
public void testProject003()
throws Exception
@@ -68,6 +70,7 @@ public class EarMojoIT
/**
* Builds an EAR with a default bundle directory for _java_ modules and a custom location overriding the default.
+ * @throws Exception in case of an error.
*/
public void testProject004()
throws Exception
@@ -78,6 +81,7 @@ public class EarMojoIT
/**
* Builds an EAR with a custom URI.
+ * @throws Exception in case of an error.
*/
public void testProject005()
throws Exception
@@ -87,6 +91,7 @@ public class EarMojoIT
/**
* Builds an EAR with an excluded module.
+ * @throws Exception in case of an error.
*/
public void testProject006()
throws Exception
@@ -97,6 +102,7 @@ public class EarMojoIT
/**
* Builds an EAR with a classified artifact and no extra configuration.
+ * @throws Exception in case of an error.
*/
public void testProject007()
throws Exception
@@ -106,6 +112,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for J2EE 1.3.
+ * @throws Exception in case of an error.
*/
public void testProject008()
throws Exception
@@ -115,6 +122,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for J2EE 1.4.
+ * @throws Exception in case of an error.
*/
public void testProject009()
throws Exception
@@ -124,6 +132,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for Java EE 5.
+ * @throws Exception in case of an error.
*/
public void testProject010()
throws Exception
@@ -133,6 +142,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that deployment descriptor default settings are applied.
+ * @throws Exception in case of an error.
*/
public void testProject011()
throws Exception
@@ -142,6 +152,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that EAR resources are bundled within the EAR.
+ * @throws Exception in case of an error.
*/
public void testProject012()
throws Exception
@@ -151,6 +162,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that EAR resources in a customized resources directory are bundled within the EAR.
+ * @throws Exception in case of an error.
*/
public void testProject013()
throws Exception
@@ -160,6 +172,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that EAR resources are bundled within the EAR using includes and excludes.
+ * @throws Exception in case of an error.
*/
public void testProject014()
throws Exception
@@ -169,6 +182,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that default manifest is taken into account.
+ * @throws Exception in case of an error.
*/
public void testProject015()
throws Exception
@@ -182,6 +196,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that custom manifest is taken into account.
+ * @throws Exception in case of an error.
*/
public void testProject016()
throws Exception
@@ -204,6 +219,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that custom application.xml is taken into account.
+ * @throws Exception in case of an error.
*/
public void testProject017()
throws Exception
@@ -213,6 +229,7 @@ public class EarMojoIT
/**
* Builds an EAR with a custom final name.
+ * @throws Exception in case of an error.
*/
public void testProject018()
throws Exception
@@ -224,6 +241,7 @@ public class EarMojoIT
/**
* Builds an EAR with unpacked archives using the unpackTypes.
+ * @throws Exception in case of an error.
*/
public void testProject019()
throws Exception
@@ -234,6 +252,7 @@ public class EarMojoIT
/**
* Builds an EAR with unpacked archives using the unpack module attribute.
+ * @throws Exception in case of an error.
*/
public void testProject020()
throws Exception
@@ -244,6 +263,7 @@ public class EarMojoIT
/**
* Builds an EAR with unpacked archives using both unpackTypes and the unpack module attribute.
+ * @throws Exception in case of an error.
*/
public void testProject021()
throws Exception
@@ -257,6 +277,7 @@ public class EarMojoIT
/**
* Builds an EAR with a classifier.
+ * @throws Exception in case of an error.
*/
public void testProject022()
throws Exception
@@ -268,6 +289,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that a single classified dependency is detected without specifying the classifier.
+ * @throws Exception in case of an error.
*/
public void testProject023()
throws Exception
@@ -279,6 +301,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that a single classified dependency is detected when specifying the classifier.
+ * @throws Exception in case of an error.
*/
public void testProject024()
throws Exception
@@ -291,6 +314,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that a classified dependency with mutiple candidates is detected when specifying the
* classifier.
+ * @throws Exception in case of an error.
*/
public void testProject025()
throws Exception
@@ -303,6 +327,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that the build fails if a unclassifed module configuration with mutiple candidates is
* specified.
+ * @throws Exception in case of an error.
*/
public void testProject026()
throws Exception
@@ -314,6 +339,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that provided dependencies are not included in the EAR.
+ * @throws Exception in case of an error.
*/
public void testProject027()
throws Exception
@@ -323,6 +349,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that test dependencies are not included in the EAR.
+ * @throws Exception in case of an error.
*/
public void testProject028()
throws Exception
@@ -332,6 +359,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that system dependencies are not included in the EAR.
+ * @throws Exception in case of an error.
*/
public void testProject029()
throws Exception
@@ -342,6 +370,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that ejb-client dependencies are detected and not added by default in the generated
* application.xml.
+ * @throws Exception in case of an error.
*/
public void testProject030()
throws Exception
@@ -353,6 +382,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 4 configuration specifying the security domain and the unauthenticated-principal to
* use.
+ * @throws Exception in case of an error.
*/
public void testProject031()
throws Exception
@@ -363,6 +393,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 3.2 configuration specifying the jmx-name to use.
+ * @throws Exception in case of an error.
*/
public void testProject032()
throws Exception
@@ -373,6 +404,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 4 configuration and Jboss specific modules.
+ * @throws Exception in case of an error.
*/
public void testProject033()
throws Exception
@@ -383,6 +415,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom security settings.
+ * @throws Exception in case of an error.
*/
public void testProject034()
throws Exception
@@ -393,6 +426,7 @@ public class EarMojoIT
/**
* Builds an EAR with a full filename mapping and make sure that custom locations are not overridden.
+ * @throws Exception in case of an error.
*/
public void testProject035()
throws Exception
@@ -406,6 +440,7 @@ public class EarMojoIT
/**
* Builds an EAR with a full filename mapping and make sure that groupIds with dots are replaced by dashes in
* filenames.
+ * @throws Exception in case of an error.
*/
public void testProject036()
throws Exception
@@ -420,6 +455,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that ejb-client dependencies are detected and added in the generated application.xml
* if includeInApplicationXml is set.
+ * @throws Exception in case of an error.
*/
public void testProject037()
throws Exception
@@ -430,6 +466,7 @@ public class EarMojoIT
/**
* Builds an EAR and make sure that a non-classified dependency with mutiple candidates is detected when specifying
* the mainArtifactId as classifier.
+ * @throws Exception in case of an error.
*/
public void testProject038()
throws Exception
@@ -440,6 +477,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 4 configuration specifying specifying the loader repository to use.
+ * @throws Exception in case of an error.
*/
public void testProject039()
throws Exception
@@ -449,6 +487,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for Java EE 5 and an alternative deployment descriptor.
+ * @throws Exception in case of an error.
*/
public void testProject040()
throws Exception
@@ -458,6 +497,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 4.2 configuration specifying the module order to use.
+ * @throws Exception in case of an error.
*/
public void testProject041()
throws Exception
@@ -467,6 +507,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 4.2 configuration specifying a datasource to add.
+ * @throws Exception in case of an error.
*/
public void testProject042()
throws Exception
@@ -476,6 +517,7 @@ public class EarMojoIT
/**
* Builds an EAR with a custom descriptor location (generatedDescriptorLocation setting).
+ * @throws Exception in case of an error.
*/
public void testProject043()
throws Exception
@@ -488,6 +530,7 @@ public class EarMojoIT
/**
* Builds an EAR with a custom library-directory.
+ * @throws Exception in case of an error.
*/
public void testProject044()
throws Exception
@@ -497,6 +540,7 @@ public class EarMojoIT
/**
* Builds an EAR and filter the content of the sources directory.
+ * @throws Exception in case of an error.
*/
public void testProject045()
throws Exception
@@ -510,6 +554,7 @@ public class EarMojoIT
/**
* Builds an EAR and filter the content of the sources directory using a custom filter file.
+ * @throws Exception in case of an error.
*/
public void testProject046()
throws Exception
@@ -525,6 +570,7 @@ public class EarMojoIT
/**
* Builds an EAR and filter the content with a list of extensions.
+ * @throws Exception in case of an error.
*/
public void testProject047()
throws Exception
@@ -538,6 +584,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 5 configuration containing library directory.
+ * @throws Exception in case of an error.
*/
public void testProject048()
throws Exception
@@ -547,6 +594,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 4.2 configuration containing a library directory.
+ * @throws Exception in case of an error.
*/
public void testProject049()
throws Exception
@@ -556,6 +604,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 5 configuration containing a loader repository configuration definition.
+ * @throws Exception in case of an error.
*/
public void testProject050()
throws Exception
@@ -565,6 +614,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 5 configuration containing a loader repository class definition.
+ * @throws Exception in case of an error.
*/
public void testProject051()
throws Exception
@@ -574,6 +624,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 5 configuration containing a configuration parser class definition.
+ * @throws Exception in case of an error.
*/
public void testProject052()
throws Exception
@@ -583,6 +634,7 @@ public class EarMojoIT
/**
* Builds an EAR with a Jboss 5 configuration containing only the loader repo configuration
+ * @throws Exception in case of an error.
*/
public void testProject053()
throws Exception
@@ -592,6 +644,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for Java EE 5 and no application.xml
+ * @throws Exception in case of an error.
*/
public void testProject054()
throws Exception
@@ -601,6 +654,7 @@ public class EarMojoIT
/**
* Builds an EAR with jar dependencies added in application.xml.
+ * @throws Exception in case of an error.
*/
public void testProject055()
throws Exception
@@ -611,6 +665,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for J2EE 1.4 and an alternative deployment descriptor.
+ * @throws Exception in case of an error.
*/
public void testProject056()
throws Exception
@@ -620,6 +675,7 @@ public class EarMojoIT
/**
* Builds an EAR with a complete JBoss 4.2 configuration and validate it matches the DTD (MEAR-104).
+ * @throws Exception in case of an error.
*/
public void testProject057()
throws Exception
@@ -629,6 +685,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for Java EE 6.
+ * @throws Exception in case of an error.
*/
public void testProject058()
throws Exception
@@ -638,6 +695,7 @@ public class EarMojoIT
/**
* Builds an EAR with no display name entry at all.
+ * @throws Exception in case of an error.
*/
public void testProject059()
throws Exception
@@ -648,7 +706,7 @@ public class EarMojoIT
/**
* Builds an EAR with ejb-client packaged for J2EE 1.3 (MEAR-85)
*
- * @throws Exception
+ * @throws Exception in case of an error.
*/
public void testProject060()
throws Exception
@@ -659,7 +717,7 @@ public class EarMojoIT
/**
* Builds an EAR with ejb-client packaged for J2EE 1.4 (MEAR-85)
*
- * @throws Exception
+ * @throws Exception in case of an error.
*/
public void testProject061()
throws Exception
@@ -670,7 +728,7 @@ public class EarMojoIT
/**
* Builds an EAR with ejb-client packaged for JavaEE 5 (MEAR-85)
*
- * @throws Exception
+ * @throws Exception in case of an error.
*/
public void testProject062()
throws Exception
@@ -681,7 +739,7 @@ public class EarMojoIT
/**
* Builds an EAR with ejb-client packaged for JavaEE 6 (MEAR-85)
*
- * @throws Exception
+ * @throws Exception in case of an error.
*/
public void testProject063()
throws Exception
@@ -692,7 +750,7 @@ public class EarMojoIT
/**
* Builds an EAR with ejb-client packaged for JavaEE 5 and still put it in the root (MEAR-85)
*
- * @throws Exception
+ * @throws Exception in case of an error.
*/
public void testProject064()
throws Exception
@@ -702,6 +760,7 @@ public class EarMojoIT
/**
* Builds an EAR with a custom moduleId.
+ * @throws Exception in case of an error.
*/
public void testProject065()
throws Exception
@@ -711,6 +770,7 @@ public class EarMojoIT
/**
* Builds an EAR with generateModuleId enabled.
+ * @throws Exception in case of an error.
*/
public void testProject066()
throws Exception
@@ -720,6 +780,7 @@ public class EarMojoIT
/**
* Builds an EAR with generateModuleId enabled and a custom module.
+ * @throws Exception in case of an error.
*/
public void testProject067()
throws Exception
@@ -729,6 +790,7 @@ public class EarMojoIT
/**
* Builds an EAR with the no-version file name mapping.
+ * @throws Exception in case of an error.
*/
public void testProject068()
throws Exception
@@ -738,6 +800,7 @@ public class EarMojoIT
/**
* Builds an EAR with a custom library-directory and JavaEE 6.
+ * @throws Exception in case of an error.
*/
public void testProject069()
throws Exception
@@ -747,6 +810,7 @@ public class EarMojoIT
/**
* Builds an EAR with application-name and initialize-in-order tags.
+ * @throws Exception in case of an error.
*/
public void testProject070()
throws Exception
@@ -756,6 +820,7 @@ public class EarMojoIT
/**
* Builds an EAR with application-name and initialize-in-order tags for unsupported version.
+ * @throws Exception in case of an error.
*/
public void testProject071()
throws Exception
@@ -765,6 +830,7 @@ public class EarMojoIT
/**
* Builds an EAR with an application client module (app-client).
+ * @throws Exception in case of an error.
*/
public void testProject072()
throws Exception
@@ -774,6 +840,7 @@ public class EarMojoIT
/**
* Builds an EAR with an application client module (app-client) and a default bundle directory for _java_ modules.
+ * @throws Exception in case of an error.
*/
public void testProject073()
throws Exception
@@ -785,6 +852,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom env entries settings and J2EE 1.3. Not supported by the specification so this should be
* ignored.
+ * @throws Exception in case of an error.
*/
public void testProject074()
throws Exception
@@ -795,6 +863,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom env entries settings and J2EE 1.4. Not supported by the specification so this should be
* ignored.
+ * @throws Exception in case of an error.
*/
public void testProject075()
throws Exception
@@ -805,6 +874,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom env entries settings and JavaEE 5. Not supported by the specification so this should be
* ignored.
+ * @throws Exception in case of an error.
*/
public void testProject076()
throws Exception
@@ -814,6 +884,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom env entries settings and JavaEE 6.
+ * @throws Exception in case of an error.
*/
public void testProject077()
throws Exception
@@ -823,6 +894,7 @@ public class EarMojoIT
/**
* Builds an EAR with the no version for ejb file name mapping.
+ * @throws Exception in case of an error.
*/
public void testProject078()
throws Exception
@@ -833,6 +905,7 @@ public class EarMojoIT
/**
* Builds an EAR with the 'default' library directory mode. Uses the value of the defaultLibBundleDir.
+ * @throws Exception in case of an error.
*/
public void testProject079()
throws Exception
@@ -842,6 +915,7 @@ public class EarMojoIT
/**
* Builds an EAR with the 'empty' library directory mode. Generate an empty library-directory element.
+ * @throws Exception in case of an error.
*/
public void testProject080()
throws Exception
@@ -851,6 +925,7 @@ public class EarMojoIT
/**
* Builds an EAR with the 'none' library directory mode. Does not generate an library-directory element.
+ * @throws Exception in case of an error.
*/
public void testProject081()
throws Exception
@@ -860,6 +935,7 @@ public class EarMojoIT
/**
* Builds an EAR with deployment descriptor configuration for JavaEE 7.
+ * @throws Exception in case of an error.
*/
public void testProject082()
throws Exception
@@ -870,6 +946,7 @@ public class EarMojoIT
/**
* Builds an EAR with a library directory and custom env entries. The library-directory element must come first
* (MEAR-158).
+ * @throws Exception in case of an error.
*/
public void testProject083()
throws Exception
@@ -879,6 +956,7 @@ public class EarMojoIT
/**
* Support of an application id (MEAR-174).
+ * @throws Exception in case of an error.
*/
public void testProject084()
throws Exception
@@ -888,6 +966,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom ejbRef entries settings and JavaEE 6.
+ * @throws Exception in case of an error.
*/
public void testProject085()
throws Exception
@@ -897,6 +976,7 @@ public class EarMojoIT
/**
* Builds an EAR with custom ejbRef entries plus lookup-name entry.
+ * @throws Exception in case of an error.
*/
public void testProject086()
throws Exception
@@ -906,6 +986,7 @@ public class EarMojoIT
/**
* Builds an EAR with resource-ref entries.
+ * @throws Exception in case of an error.
*/
public void testProject087()
throws Exception
--
To stop receiving notification emails like this one, please contact
khmarbaise@apache.org.