svn commit: r374564 - in /incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen: BytecodeInterfaceGenerator.java JavaInterfaceGenerator.java

[jb...@apache.org]

Author: jboynes
Date: Thu Feb  2 18:15:18 2006
New Revision: 374564

URL: http://svn.apache.org/viewcvs?rev=374564&view=rev
Log:
add javadoc

Modified:
    incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/BytecodeInterfaceGenerator.java
    incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/JavaInterfaceGenerator.java

Modified: incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/BytecodeInterfaceGenerator.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/BytecodeInterfaceGenerator.java?rev=374564&r1=374563&r2=374564&view=diff
==============================================================================
--- incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/BytecodeInterfaceGenerator.java (original)
+++ incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/BytecodeInterfaceGenerator.java Thu Feb  2 18:15:18 2006
@@ -26,12 +26,15 @@
 import org.apache.tuscany.sdo.SDOTypeVisitor;
 
 /**
+ * Implementation of a generator that will directly emit bytecode for an interface that
+ * corresponds to the static properties of a SDO type.
+ *
  * @version $Rev$ $Date$
  */
 public class BytecodeInterfaceGenerator implements SDOTypeVisitor {
     private final ClassWriter cw;
 
-    protected BytecodeInterfaceGenerator() {
+    public BytecodeInterfaceGenerator() {
         cw = new ClassWriter(false);
     }
 
@@ -78,6 +81,12 @@
         cw.visitEnd();
     }
 
+    /**
+     * Return the bytecode for the interface class in a form that can be written
+     * to disk, added to a JAR file, or passed to a ClassLoader.
+     *
+     * @return the bytecode for the SDO Type's interface class
+     */
     public byte[] getClassData() {
         return cw.toByteArray();
     }

Modified: incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/JavaInterfaceGenerator.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/JavaInterfaceGenerator.java?rev=374564&r1=374563&r2=374564&view=diff
==============================================================================
--- incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/JavaInterfaceGenerator.java (original)
+++ incubator/tuscany/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/codegen/JavaInterfaceGenerator.java Thu Feb  2 18:15:18 2006
@@ -25,11 +25,19 @@
 import org.apache.tuscany.sdo.SDOTypeVisitor;
 
 /**
+ * Implementation of a generator that will output the source code for a Java interface
+ * that corresponds to the SDO Type's static properties.
+ *
  * @version $Rev$ $Date$
  */
 public class JavaInterfaceGenerator implements SDOTypeVisitor {
     private final PrintWriter writer;
 
+    /**
+     * Constructor providing the Writer to output the source to.
+     *
+     * @param writer where the generated source code will be written to 
+     */
     public JavaInterfaceGenerator(PrintWriter writer) {
         this.writer = writer;
     }