[jboss-cvs] JBossAS SVN: r105139 - 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
Mon May 24 06:07:31 EDT 2010
Author: jeff.zhang
Date: 2010-05-24 06:07:30 -0400 (Mon, 24 May 2010)
New Revision: 105139
Modified:
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/AbstractCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CciConnCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CciConnFactoryCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CfCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CfInterfaceCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CmCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnImplCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnInterfaceCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnMetaCodeGen.java
projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McMetaCodeGen.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/RaMetaCodeGen.java
Log:
[JBJCA-330] add javadoc for generated method, cci classes, cf classes
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/AbstractCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/AbstractCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/AbstractCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -75,6 +75,8 @@
writeEol(out);
out.write(" * " + getClassName(def));
writeEol(out);
+ out.write(" *");
+ writeEol(out);
out.write(" * @version $Revision: $");
writeEol(out);
out.write(" */");
@@ -206,6 +208,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);
@@ -229,6 +244,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 other 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/CciConnCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CciConnCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CciConnCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -50,6 +50,19 @@
//constructor
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * default constructor");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param connSpec ConnectionSpec");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public " + getClassName(def) + "(ConnectionSpec connSpec)");
writeLeftCurlyBracket(out, indent);
writeRightCurlyBracket(out, indent);
@@ -116,6 +129,22 @@
private void writeClose(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Initiates close of the connection handle at the application level.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Exception thrown if close on a connection handle fails.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -136,6 +165,25 @@
private void writeInteraction(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Creates an Interaction associated with this Connection. ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Interaction instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to create an Interaction");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -158,6 +206,31 @@
private void writeLocalTransaction(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns an LocalTransaction instance that enables a component to ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * demarcate resource manager local transactions on the Connection.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return LocalTransaction instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to return a LocalTransaction");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws javax.resource.NotSupportedException Demarcation of Resource manager ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -180,6 +253,25 @@
private void writeMetaData(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets the information on the underlying EIS instance represented through an active connection.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return ConnectionMetaData instance representing information about the EIS instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get information about the connected EIS instance. ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -203,6 +295,31 @@
private void writeResultSetInfo(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets the information on the ResultSet functionality supported by ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * a connected EIS instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return ResultSetInfo instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get ResultSet related information");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws javax.resource.NotSupportedException ResultSet functionality is not supported");
+ 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/CciConnFactoryCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CciConnFactoryCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CciConnFactoryCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -55,6 +55,19 @@
//constructor
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * default constructor");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param cxManager ConnectionManager");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public " + getClassName(def) + "(ConnectionManager cxManager)");
writeLeftCurlyBracket(out, indent);
writeRightCurlyBracket(out, indent);
@@ -122,6 +135,25 @@
private void writeConnection(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets a connection to an EIS instance. ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Connection instance the EIS instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get a connection to");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -134,6 +166,29 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets a connection to an EIS instance. ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param connSpec Connection parameters and security information specified as " +
+ "ConnectionSpec instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Connection instance the EIS instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get a connection to");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -156,6 +211,25 @@
private void writeMetaData(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets metadata for the Resource Adapter. ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return ResourceAdapterMetaData instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get metadata information ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -178,6 +252,28 @@
private void writeRecordFactory(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets a RecordFactory instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return RecordFactory instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to create a RecordFactory");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws javax.resource.NotSupportedException Operation not supported");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -200,6 +296,22 @@
private void writeReference(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Get the Reference instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Reference instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -211,6 +323,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Set the Reference instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param reference A Reference instance");
+ 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/CfCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CfCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CfCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -55,6 +55,19 @@
//constructor
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * default constructor");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param cxManager ConnectionManager");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public " + getClassName(def) + "(ConnectionManager cxManager)");
writeLeftCurlyBracket(out, indent);
writeRightCurlyBracket(out, indent);
@@ -115,6 +128,22 @@
private void writeConnection(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/** ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * get connection from factory");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return " + def.getConnInterfaceClass() + " instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -137,6 +166,22 @@
private void writeReference(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Get the Reference instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Reference instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -148,6 +193,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Set the Reference instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param reference A Reference instance");
+ 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/CfInterfaceCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CfInterfaceCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CfInterfaceCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -93,6 +93,22 @@
private void writeConnection(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/** ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * get connection from factory");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return " + def.getConnInterfaceClass() + " instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public " + def.getConnInterfaceClass() + " getConnection() throws ResourceException;");
writeEol(out);
}
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CmCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CmCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/CmCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -97,6 +97,31 @@
private void writeAllocateConn(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Allocate a connection");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param mcf The managed connection factory");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @param cri The connection request information");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Object The connection");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @exception ResourceException Thrown if an error occurs");
+ 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/ConnImplCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnImplCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnImplCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -47,6 +47,9 @@
writeLeftCurlyBracket(out, 0);
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);
@@ -54,6 +57,16 @@
writeDefaultConstructor(def, out, indent);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * call me");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public void callMe()");
writeLeftCurlyBracket(out, indent);
writeIndent(out, indent + 1);
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnInterfaceCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnInterfaceCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnInterfaceCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -43,10 +43,21 @@
public void writeClassBody(Definition def, Writer out) throws IOException
{
int indent = 1;
+
out.write("public interface " + getClassName(def));
writeLeftCurlyBracket(out, 0);
-
+
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * call me");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("public void callMe();");
writeRightCurlyBracket(out, 0);
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnMetaCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnMetaCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/ConnMetaCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -95,6 +95,25 @@
private void writeEIS(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns product name of the underlying EIS instance connected");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Product name of the EIS instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get the information");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -104,6 +123,25 @@
out.write("return null; //TODO");
writeRightCurlyBracket(out, indent);
writeEol(out);
+
+ writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns product version of the underlying EIS instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Product version of the EIS instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get the information");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
writeIndent(out, indent);
out.write("@Override");
@@ -127,6 +165,25 @@
private void writeUsername(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns the user name for an active connection as known to the underlying EIS instance.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return String representing the user name");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Failed to get the information");
+ 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/McMetaCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McMetaCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McMetaCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -96,6 +96,25 @@
private void writeEIS(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns Product name of the underlying EIS instance connected through the ManagedConnection.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Product name of the EIS instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Thrown if an error occurs");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -107,6 +126,25 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns Product version of the underlying EIS instance connected through the ManagedConnection.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Product version of the EIS instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Thrown if an error occurs");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -128,6 +166,25 @@
private void writeMaxConnection(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns maximum limit on number of active concurrent connections ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Maximum limit for number of active concurrent connections");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Thrown if an error occurs");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -150,6 +207,25 @@
private void writeUsername(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns name of the user associated with the ManagedConnection instance");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return name of the user");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @throws ResourceException Thrown if an error occurs");
+ 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/McfCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McfCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/McfCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -92,6 +92,9 @@
if (def.isImplRaAssociation())
{
writeIndent(out, indent);
+ out.write("/** The resource adapter */");
+ writeEol(out);
+ writeIndent(out, indent);
out.write("private ResourceAdapter ra;");
writeEol(out);
writeEol(out);
Modified: projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaMetaCodeGen.java
===================================================================
--- projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaMetaCodeGen.java 2010-05-24 09:16:21 UTC (rev 105138)
+++ projects/jboss-jca/trunk/codegenerator/src/main/java/org/jboss/jca/codegenerator/RaMetaCodeGen.java 2010-05-24 10:07:30 UTC (rev 105139)
@@ -92,6 +92,22 @@
private void writeInfo(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets the version of the resource adapter.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return String representing version of the resource adapter");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -103,6 +119,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets the name of the vendor that has provided the resource adapter.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return String representing name of the vendor ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -114,6 +146,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets a tool displayable name of the resource adapter.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return String representing the name of the resource adapter");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -125,6 +173,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Gets a tool displayable short desription of the resource adapter.");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return String describing the resource adapter");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -136,6 +200,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns a string representation of the version");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return String representing the supported version of the connector architecture");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -157,6 +237,22 @@
private void writeSupport(Definition def, Writer out, int indent) throws IOException
{
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns an array of fully-qualified names of InteractionSpec");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return Array of fully-qualified class names of InteractionSpec classes");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -168,6 +264,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns true if the implementation class for the Interaction");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return boolean depending on method support");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -179,6 +291,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns true if the implementation class for the Interaction");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return boolean depending on method support");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
@@ -190,6 +318,22 @@
writeEol(out);
writeIndent(out, indent);
+ out.write("/**");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * Returns true if the resource adapter implements the LocalTransaction");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" *");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" * @return true if resource adapter supports resource manager local transaction demarcation ");
+ writeEol(out);
+ writeIndent(out, indent);
+ out.write(" */");
+ writeEol(out);
+
+ writeIndent(out, indent);
out.write("@Override");
writeEol(out);
writeIndent(out, indent);
More information about the jboss-cvs-commits
mailing list