Author: painter
Date: Thu Jan 10 18:09:47 2019
New Revision: 1850969
URL: http://svn.apache.org/viewvc?rev=1850969&view=rev
Log:
JavaDoc cleanup, mvn javadoc:javadoc runs ok now
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/Platform.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDefaultImpl.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDerbyImpl.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/IncludeSchemaTransformer.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/LoadExternalSchemaTransformer.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMColumnTransformer.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMJoinGetterTransformer.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMTransformer.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SchemaType.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SizedForBitDataSqlType.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SqlType.java
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/TypeMap.java
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/Platform.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/Platform.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/Platform.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/Platform.java
Thu Jan 10 18:09:47 2019
@@ -43,6 +43,7 @@ public interface Platform
SqlType getSqlTypeForSchemaType(SchemaType schemaType);
/**
+ * @param notNull flag for not null
* @return The RDBMS-specific SQL fragment for <code>NULL</code>
* or <code>NOT NULL</code>.
*/
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDefaultImpl.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDefaultImpl.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDefaultImpl.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDefaultImpl.java
Thu Jan 10 18:09:47 2019
@@ -75,7 +75,7 @@ public class PlatformDefaultImpl impleme
}
/**
- * Adds a mapping to the torque schema type -> sql type map.
+ * Adds a mapping to the torque schema type -> sql type map.
*
* @param schemaType the torque schema type which should be mapped,
* not null.
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDerbyImpl.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDerbyImpl.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDerbyImpl.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/platform/PlatformDerbyImpl.java
Thu Jan 10 18:09:47 2019
@@ -67,8 +67,8 @@ public class PlatformDerbyImpl extends P
new SqlType("SMALLINT"));
}
- /**
- * @see Platform#getAutoIncrement(
+ /* (non-Javadoc)
+ * @see
org.apache.torque.templates.platform.PlatformDefaultImpl#getAutoIncrement()
*/
@Override
public String getAutoIncrement()
@@ -76,8 +76,8 @@ public class PlatformDerbyImpl extends P
return "GENERATED BY DEFAULT AS IDENTITY";
}
- /**
- * @see Platform#hasScale(String)
+ /* (non-Javadoc)
+ * @see
org.apache.torque.templates.platform.PlatformDefaultImpl#hasScale(java.lang.String)
*/
@Override
public boolean hasScale(String sqlType)
@@ -85,8 +85,8 @@ public class PlatformDerbyImpl extends P
return "NUMERIC".equals(sqlType) || "DECIMAL".equals(sqlType);
}
- /**
- * @see Platform#hasSize(String)
+ /* (non-Javadoc)
+ * @see
org.apache.torque.templates.platform.PlatformDefaultImpl#hasSize(java.lang.String)
*/
@Override
public boolean hasSize(String sqlType)
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/IncludeSchemaTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/IncludeSchemaTransformer.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/IncludeSchemaTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/IncludeSchemaTransformer.java
Thu Jan 10 18:09:47 2019
@@ -159,7 +159,7 @@ public class IncludeSchemaTransformer im
*
* @param database the database root element of the source tree, not null.
* @param controllerState the controller state, not null.
- *
+ * @return Database object
* @throws SourceTransformerException if the transformation fails.
*/
public Database transform(
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/LoadExternalSchemaTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/LoadExternalSchemaTransformer.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/LoadExternalSchemaTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/LoadExternalSchemaTransformer.java
Thu Jan 10 18:09:47 2019
@@ -50,7 +50,7 @@ public class LoadExternalSchemaTransform
{
/** The class log. */
private static Log log
- = LogFactory.getLog(LoadExternalSchemaTransformer.class);
+ = LogFactory.getLog(LoadExternalSchemaTransformer.class);
/**
* The base dir for the external schema,
@@ -91,7 +91,7 @@ public class LoadExternalSchemaTransform
*
* @param modelRoot the database root element of the source tree, not null.
* @param controllerState the controller state, not null.
- *
+ * @return SourceElement
* @throws SourceTransformerException if the transformation fails.
*/
@Override
@@ -210,7 +210,7 @@ public class LoadExternalSchemaTransform
*
* @param database the database root element of the source tree, not null.
* @param controllerState the controller state, not null.
- *
+ * @return Database object
* @throws SourceTransformerException if the transformation fails.
*/
public Database transform(
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMColumnTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMColumnTransformer.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMColumnTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMColumnTransformer.java
Thu Jan 10 18:09:47 2019
@@ -102,6 +102,12 @@ public class OMColumnTransformer
= Collections.unmodifiableSet(reservedConstantNames);
}
+ /**
+ * @param columnElement column to transform
+ * @param controllerState the controller state object
+ * @param columnPosition column position
+ * @throws SourceTransformerException if the column cannot be found
+ */
public void transform(
final SourceElement columnElement,
final ControllerState controllerState,
@@ -339,6 +345,7 @@ public class OMColumnTransformer
* @param enumClassName the class name of the enum, or null if the column
is not an enum.
*
* @return the java type of the column
+ * @throws SourceTransformerException if error in transform
*/
protected JavaType setFieldJavaType(
final SourceElement columnElement,
@@ -894,6 +901,7 @@ public class OMColumnTransformer
* @param javaType The java type of the column.
*
* @return The java default value.
+ * @throws SourceTransformerException if the value cannot be found
*/
protected String getDefaultValueWithoutDefaultSet(final JavaType javaType)
throws SourceTransformerException
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMJoinGetterTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMJoinGetterTransformer.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMJoinGetterTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMJoinGetterTransformer.java
Thu Jan 10 18:09:47 2019
@@ -33,7 +33,7 @@ import org.apache.torque.templates.Torqu
* The OMReferencingForeignKeyTableTransformer needs to be run
* before this transformation
* The structure before transformation is:
- *
+ * <pre>
* table
* foreign-key
* ...
@@ -50,8 +50,10 @@ import org.apache.torque.templates.Torqu
* ...
* table
* ...
- *
+ * </pre>
+ *
* The structure after transformation is
+ * <pre>
* table
* foreign-key
* ...
@@ -75,9 +77,16 @@ import org.apache.torque.templates.Torqu
* foreign-key (a foreign key of the referenced table)
*
* ...
+ * </pre>
+ *
*/
public class OMJoinGetterTransformer
{
+ /**
+ * @param tableElement the table
+ * @param controllerState the controller state
+ * @throws SourceTransformerException if the table cannot be joined
+ */
public void transform(
final SourceElement tableElement,
final ControllerState controllerState)
@@ -156,7 +165,7 @@ public class OMJoinGetterTransformer
/**
* Checks that the name of the table element is correct.
*
- * @param columnElement the table element, not null.
+ * @param tableElement the table element, not null.
*
* @throws IllegalArgumentException if the element name is wrong.
*/
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMTransformer.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/transformer/om/OMTransformer.java
Thu Jan 10 18:09:47 2019
@@ -51,7 +51,7 @@ import org.apache.torque.templates.trans
* <li>OMTableAndViewTransformer on all tables and views</li>
* <li>OMForeignKeyColumnTransformer on all columns</li>
* <li>OMForeignKeyTransformer on all foreign keys (two passes)</li>
- * <ul>
+ * </ul>
*
* $Id$
*/
@@ -219,7 +219,7 @@ public class OMTransformer implements So
* Sets the rootDatabaseName attribute of the database element
* to the database's name.
*
- * @param databaseElement the database element, not null.
+ * @param database the database element, not null.
*/
public static void setRootDatabaseName(final Database database)
{
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SchemaType.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SchemaType.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SchemaType.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SchemaType.java
Thu Jan 10 18:09:47 2019
@@ -24,7 +24,7 @@ import java.sql.Types;
/**
* Enum for known SQL types.
*
- * @author <a href="mailto:[email protected]>Martin Poeschl</a>
+ * @author <a href="mailto:[email protected]";>Martin Poeschl</a>
* @version $Id$
*/
public enum SchemaType
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SizedForBitDataSqlType.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SizedForBitDataSqlType.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SizedForBitDataSqlType.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SizedForBitDataSqlType.java
Thu Jan 10 18:09:47 2019
@@ -54,7 +54,7 @@ import org.apache.commons.lang.StringUti
public class SizedForBitDataSqlType extends SqlType
{
/**
- * @see SqlType#SqlType(String)
+ * @param sqlType the sql type
*/
public SizedForBitDataSqlType(final String sqlType)
{
@@ -62,7 +62,8 @@ public class SizedForBitDataSqlType exte
}
/**
- * @see SqlType#SqlType(String, String)
+ * @param sqlType the sql type
+ * @param size size
*/
public SizedForBitDataSqlType(final String sqlType, final String size)
{
@@ -70,7 +71,10 @@ public class SizedForBitDataSqlType exte
}
/**
- * @see SqlType#SqlType(String, String, string, String)
+ * @param sqlType the sql type
+ * @param size of the data
+ * @param scale of the data
+ * @param defaultValue for the data
*/
public SizedForBitDataSqlType(
final SqlType sqlType,
@@ -82,11 +86,12 @@ public class SizedForBitDataSqlType exte
}
/**
+ * @see
org.apache.torque.templates.typemapping.SqlType#printSize(java.lang.String)
+
* Returns the size postfix for the base SQL Column type.
*
* @return "(size) FOR BIT DATA" or just " FOR BIT DATA" if size
* is null.
- * @see org.apache.torque.SqlType.database.model.Domain#getSize()
*/
@Override
public String printSize(final String sizeSuffix)
@@ -100,7 +105,9 @@ public class SizedForBitDataSqlType exte
return result;
}
- /**
+ /* (non-Javadoc)
+ * @see
org.apache.torque.templates.typemapping.SqlType#getNew(java.lang.String,
java.lang.String, java.lang.String)
+ *
* Returns a new instance with the given sqlTypeName, size, scale
* and default value.
*
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SqlType.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SqlType.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SqlType.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/SqlType.java
Thu Jan 10 18:09:47 2019
@@ -54,7 +54,7 @@ public class SqlType
* Creates a new SqlType with the given SQL Type.
* Size, scale and defaultValue are set to null.
*
- * @param sqlType the SQL name of the SQL type, or null.
+ * @param sqlTypeName the SQL name of the SQL type, or null.
*/
public SqlType(final String sqlTypeName)
{
@@ -127,7 +127,7 @@ public class SqlType
* @param sqlType the SQL type, to copy, not null.
* @param size the default size of the columns with this SQL type.
* @param scale the default scale of the columns with this SQL type.
-ยดยด * @param defaultValue the default "default value" of the columns with this
+ * @param defaultValue the default "default value" of the columns with this
* SQL type.
*
* @throws NullPointerException if sqlType is null.
@@ -203,6 +203,7 @@ public class SqlType
/**
* Return the size and scale in brackets for use in an SQL script.
*
+ * @param sizeSuffix size suffix value
* @return size and scale or an empty String if there are no values
* available.
*/
@@ -225,7 +226,9 @@ public class SqlType
/**
* Returns a new instance with the given sqlTypeName, size, scale
* and default value.
- *
+ * @param size of the sql
+ * @param scale of the sql
+ * @param defaultValue to be provided
* @return a new instance with the given parameters.
*/
public SqlType getNew(
Modified:
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/TypeMap.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/TypeMap.java?rev=1850969&r1=1850968&r2=1850969&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/TypeMap.java
(original)
+++
db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/typemapping/TypeMap.java
Thu Jan 10 18:09:47 2019
@@ -64,7 +64,7 @@ import java.util.Set;
* </pre>
*
* @author <a href="mailto:[email protected]";>Jason van Zyl</a>
- * @author <a href="mailto:[email protected]>Martin Poeschl</a>
+ * @author <a href="mailto:[email protected]";>Martin Poeschl</a>
* @version $Id$
*/
public final class TypeMap
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
