Author: tfischer Date: Wed Sep 8 07:12:45 2010 New Revision: 993636 URL: http://svn.apache.org/viewvc?rev=993636&view=rev Log: - created missing package documentation - added javadoc - other code cleaning Added: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/package.html db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/package.html db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/package.html db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/package.html Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceSaxHandler.java Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java?rev=993636&r1=993635&r2=993636&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java Wed Sep 8 07:12:45 2010 @@ -76,7 +76,7 @@ public class Controller * @throws IOException if a IOException occurs during processing. */ public void run(List unitDescriptors) - throws ControllerException, GeneratorException, SourceException, + throws ControllerException, GeneratorException, SourceTransformerException, IOException { initLogging(); Added: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/package.html URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/package.html?rev=993636&view=auto ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/package.html (added) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/package.html Wed Sep 8 07:12:45 2010 @@ -0,0 +1,25 @@ + + + + Torque generator file handling + + +

+ This package contains utility classes for file handling. +

+ + Added: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/package.html URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/package.html?rev=993636&view=auto ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/package.html (added) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/package.html Wed Sep 8 07:12:45 2010 @@ -0,0 +1,25 @@ + + + + Torque generator JDBC utilitites + + +

+ This package contains jdbc utility classes. +

+ + Added: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/package.html URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/package.html?rev=993636&view=auto ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/package.html (added) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/package.html Wed Sep 8 07:12:45 2010 @@ -0,0 +1,25 @@ + + + + Torque generator main package + + +

+ This package contains classes neended throughout the Torque generator. +

+ + Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java?rev=993636&r1=993635&r2=993636&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java Wed Sep 8 07:12:45 2010 @@ -634,18 +634,33 @@ public class SourceElement } /** - * Overrides the add and remove methods such that the parents of the - * source element are updated as well. + * A list of children which overrides the add and remove methods + * such that the parents of the source element are updated as well. */ private static class ChildList extends AbstractList { + /** The source element to which this child list belongs, not null. */ private SourceElement sourceElement; + /** The children list, not null. */ private List children = new ArrayList(); + /** + * Constructor. + * + * @param sourceElement The source element to which + * this child list belongs, not null. + * + * @throws NullPointerException if sourceElement is null. + */ public ChildList(SourceElement sourceElement) { + if (sourceElement == null) + { + throw new NullPointerException( + "sourceElement must not be null"); + } this.sourceElement = sourceElement; } @@ -713,13 +728,28 @@ public class SourceElement */ private static class ParentList extends AbstractList { + /** The source element to which this parent list belongs, not null. */ private SourceElement sourceElement; + /** The parent list, not null. */ private List parents = new ArrayList(); + /** + * Constructor. + * + * @param sourceElement The source element to which + * this parent list belongs, not null. + * + * @throws NullPointerException if sourceElement is null. + */ public ParentList(SourceElement sourceElement) { + if (sourceElement == null) + { + throw new NullPointerException( + "sourceElement must not be null"); + } this.sourceElement = sourceElement; } Added: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/package.html URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/package.html?rev=993636&view=auto ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/package.html (added) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/package.html Wed Sep 8 07:12:45 2010 @@ -0,0 +1,25 @@ + + + + Torque generator JDBC source + + +

+ This package implements sources which read from jdbc. +

+ + Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceSaxHandler.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceSaxHandler.java?rev=993636&r1=993635&r2=993636&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceSaxHandler.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceSaxHandler.java Wed Sep 8 07:12:45 2010 @@ -21,7 +21,6 @@ package org.apache.torque.generator.sour import java.io.IOException; -import org.apache.torque.generator.configuration.ConfigurationEntityResolver; import org.apache.torque.generator.configuration.source.EntityReferences; import org.apache.torque.generator.source.SourceElement; import org.xml.sax.Attributes; @@ -126,7 +125,7 @@ public class XmlSourceSaxHandler extends * * @return an InputSource for the entity, or null if the URI is not known. * - * @see ConfigurationEntityResolver#resolveEntity(String, String) + * @see org.apache.torque.generator.configuration.ConfigurationEntityResolver#resolveEntity(String, String) */ @Override public InputSource resolveEntity(String publicId, String systemId) --------------------------------------------------------------------- To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org For additional commands, e-mail: torque-dev-help@db.apache.org