[jboss-cvs] JBossAS SVN: r105088 - projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri May 21 08:41:11 EDT 2010
Author: jeff.zhang
Date: 2010-05-21 08:41:10 -0400 (Fri, 21 May 2010)
New Revision: 105088
Modified:
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McfCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/PropsCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaCodeGen.java
Log:
[JBJCA-330] add javadoc for hashcode, equals, properties values
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McCodeGen.java 2010-05-21 12:18:17 UTC (rev 105087)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McCodeGen.java 2010-05-21 12:41:10 UTC (rev 105088)
@@ -24,9 +24,6 @@
import java.io.IOException;
import java.io.Writer;
-import javax.resource.ResourceException;
-
-
/**
* A managed connection CodeGen.
*
@@ -51,6 +48,9 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/** The logger */");
+ writeEol(out);
+ writeIndent(out, indent);
out.write("private static Logger log = Logger.getLogger(" + getClassName(def) + ".class);");
writeEol(out);
writeEol(out);
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McfCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McfCodeGen.java 2010-05-21 12:18:17 UTC (rev 105087)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McfCodeGen.java 2010-05-21 12:41:10 UTC (rev 105088)
@@ -25,8 +25,6 @@
import java.io.Writer;
import java.util.List;
-import javax.resource.ResourceException;
-
/**
* A McfCodeGen.
*
@@ -85,6 +83,9 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/** The logger */");
+ writeEol(out);
+ writeIndent(out, indent);
out.write("private static Logger log = Logger.getLogger(" + getClassName(def) + ".class);");
writeEol(out);
writeEol(out);
@@ -95,7 +96,11 @@
writeEol(out);
writeEol(out);
}
+
writeIndent(out, indent);
+ out.write("/** The logwriter */");
+ writeEol(out);
+ writeIndent(out, indent);
out.write("private PrintWriter logwriter;");
writeEol(out);
writeEol(out);
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/PropsCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/PropsCodeGen.java 2010-05-21 12:18:17 UTC (rev 105087)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/PropsCodeGen.java 2010-05-21 12:41:10 UTC (rev 105088)
@@ -48,6 +48,10 @@
for (int i = 0; i < getConfigProps(def).size(); i++)
{
writeIndent(out, indent);
+ out.write("/** " + getConfigProps(def).get(i).getName() + " */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@ConfigProperty(defaultValue=\"" + getConfigProps(def).get(i).getValue() + "\")");
writeEol(out);
writeIndent(out, indent);
@@ -66,6 +70,19 @@
String upcaseName = upcaseFirst(name);
//set
writeIndent(out, indent);
+ out.write("/** ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * set " + name);
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param " + name + " The value");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public void set" +
upcaseName +
"(" +
@@ -81,6 +98,18 @@
//get
writeIndent(out, indent);
+ out.write("/** ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * get " + name);
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return The value");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+ writeIndent(out, indent);
out.write("public " +
getConfigProps(def).get(i).getType() +
" get" +
@@ -105,6 +134,19 @@
void writeHashCode(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/** ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns a hash code value for the object.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return a hash code value for this object.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -147,6 +189,22 @@
void writeEquals(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/** ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Indicates whether some other object is equal to this one.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param obj the reference object with which to compare.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return true if this object is the same as the obj argument; false otherwise.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaCodeGen.java 2010-05-21 12:18:17 UTC (rev 105087)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaCodeGen.java 2010-05-21 12:41:10 UTC (rev 105088)
@@ -25,9 +25,6 @@
import java.io.Writer;
import java.util.List;
-import javax.resource.ResourceException;
-import javax.resource.spi.ResourceAdapterInternalException;
-
/**
* A resource adapter code generator
*
@@ -53,6 +50,10 @@
int indent = 1;
writeIndent(out, indent);
+ out.write("/** The logger */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("private static Logger log = Logger.getLogger(" + getClassName(def) + ".class);");
writeEol(out);
writeEol(out);
More information about the jboss-cvs-commits
mailing list