javadoc

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@473112 13f79535-47bb-0310-9956-ffa450edef68

src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java

@@ -52,21 +52,29 @@ import org.xml.sax.InputSource;
     jar.
 */
 public class WeblogicDeploymentTool extends GenericDeploymentTool {
+    /** EJB11 id */
     public static final String PUBLICID_EJB11
          = "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN";
+    /** EJB20 id */
     public static final String PUBLICID_EJB20
          = "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN";
+    /** Weblogic 5.1.0 id */
     public static final String PUBLICID_WEBLOGIC_EJB510
          = "-//BEA Systems, Inc.//DTD WebLogic 5.1.0 EJB//EN";
+    /** Weblogic 6.0.0 id */
     public static final String PUBLICID_WEBLOGIC_EJB600
          = "-//BEA Systems, Inc.//DTD WebLogic 6.0.0 EJB//EN";
+    /** Weblogic 7.0.0 id */
     public static final String PUBLICID_WEBLOGIC_EJB700
          = "-//BEA Systems, Inc.//DTD WebLogic 7.0.0 EJB//EN";
 
+    /** Weblogic 5.1 dtd location */
     protected static final String DEFAULT_WL51_EJB11_DTD_LOCATION
          = "/weblogic/ejb/deployment/xml/ejb-jar.dtd";
+    /** Weblogic 6.0 ejb 1.1 dtd location */
     protected static final String DEFAULT_WL60_EJB11_DTD_LOCATION
          = "/weblogic/ejb20/dd/xml/ejb11-jar.dtd";
+    /** Weblogic 6.0 ejb 2.0 dtd location */
     protected static final String DEFAULT_WL60_EJB20_DTD_LOCATION
          = "/weblogic/ejb20/dd/xml/ejb20-jar.dtd";
 
@@ -144,13 +152,17 @@ public class WeblogicDeploymentTool extends GenericDeploymentTool {
 
     /**
      * Add a nested sysproperty element.
+     * @param sysp the element to add.
      */
     public void addSysproperty(Environment.Variable sysp) {
         sysprops.add(sysp);
     }
 
 
-    /** Get the classpath to the weblogic classpaths  */
+    /**
+     * Get the classpath to the weblogic classpaths.
+     * @return the classpath to configure.
+     */
     public Path createWLClasspath() {
         if (wlClasspath == null) {
             wlClasspath = new Path(getTask().getProject());
@@ -162,6 +174,7 @@ public class WeblogicDeploymentTool extends GenericDeploymentTool {
      * If set ejbc will use this directory as the output
      * destination rather than a jar file. This allows for the
      * generation of "exploded" jars.
+     * @param outputDir the directory to be used.
      */
     public void setOutputDir(File outputDir) {
         this.outputDir = outputDir;
@@ -175,7 +188,8 @@ public class WeblogicDeploymentTool extends GenericDeploymentTool {
      * In that case, the standard weblogic classes should be set with
      * this attribute (or equivalent nested element) and the
      * home and remote interfaces located with the standard classpath
-     * attribute
+     * attribute.
+     * @param wlClasspath the path to be used.
      */
     public void setWLClasspath(Path wlClasspath) {
         this.wlClasspath = wlClasspath;
@@ -191,7 +205,8 @@ public class WeblogicDeploymentTool extends GenericDeploymentTool {
      * and the <code>build.compiler</code> property is set
      * to jikes, the Jikes compiler will be used. If this
      * is not desired, the value &quot;<code>default</code>&quot;
-     * may be given to use the default compiler
+     * may be given to use the default compiler.
+     * @param compiler the compiler to be used.
      */
     public void setCompiler(String compiler) {
         this.compiler = compiler;
@@ -207,6 +222,7 @@ public class WeblogicDeploymentTool extends GenericDeploymentTool {
      * can be generated by merely replacing the changed classes
      * and not rerunning ejbc. Setting this to false will reduce
      * the time to run ejbjar.
+     * @param rebuild a <code>boolean</code> value.
      */
     public void setRebuild(boolean rebuild) {
         this.alwaysRebuild = rebuild;
@@ -265,6 +281,7 @@ public class WeblogicDeploymentTool extends GenericDeploymentTool {
     /**
      * Any optional extra arguments pass to the weblogic.ejbc
      * tool.
+     * @param args extra arguments to pass to the ejbc tool.
      */
     public void setArgs(String args) {
         this.additionalArgs = args;