Author: tfischer
Date: Fri Sep 21 19:59:16 2012
New Revision: 1388656
URL: http://svn.apache.org/viewvc?rev=1388656&view=rev
Log:
Fix javadoc
add @override annotations
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AutoIncrementIdGenerator.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/mapper/RecordMapper.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/StandardBuilder.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/WhereClausePsPartBuilder.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeer.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/JdbcTypedValue.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Avg.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Count.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Max.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Min.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/SQLFunction.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Sum.java
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AutoIncrementIdGenerator.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AutoIncrementIdGenerator.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AutoIncrementIdGenerator.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AutoIncrementIdGenerator.java
Fri Sep 21 19:59:16 2012
@@ -34,11 +34,13 @@ public class AutoIncrementIdGenerator ex
/**
* Creates an IdGenerator which will work with the specified database.
*
- * @param dbAdapter the adapter that knows the correct sql syntax.
+ * @param adapter the adapter that knows the correct sql syntax.
* @param databaseName The name of the databaseName to find the correct
* schema.
*/
- public AutoIncrementIdGenerator(final Adapter adapter, final String
databaseName)
+ public AutoIncrementIdGenerator(
+ final Adapter adapter,
+ final String databaseName)
{
super(adapter, databaseName);
}
@@ -48,6 +50,7 @@ public class AutoIncrementIdGenerator ex
*
* @return a <code>boolean</code> value
*/
+ @Override
public boolean isPriorToInsert()
{
return false;
@@ -58,6 +61,7 @@ public class AutoIncrementIdGenerator ex
*
* @return a <code>boolean</code> value
*/
+ @Override
public boolean isPostInsert()
{
return true;
@@ -69,6 +73,7 @@ public class AutoIncrementIdGenerator ex
*
* @return a <code>boolean</code> value
*/
+ @Override
public final boolean isConnectionRequired()
{
return true;
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/mapper/RecordMapper.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/mapper/RecordMapper.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/mapper/RecordMapper.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/mapper/RecordMapper.java
Fri Sep 21 19:59:16 2012
@@ -44,7 +44,7 @@ public interface RecordMapper<T> extends
*
* @param resultSet the resultSet to operate on, already pointing
* to the correct row. Not null.
- * @param a possible offset in the rows to be considered
+ * @param rowOffset a possible offset in the rows to be considered
* (if previous rows contain other objects).
*
* @return the mapped object, not null.
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/StandardBuilder.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/StandardBuilder.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/StandardBuilder.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/StandardBuilder.java
Fri Sep 21 19:59:16 2012
@@ -49,14 +49,14 @@ public class StandardBuilder extends Abs
public PreparedStatementPart buildPs(
WhereClauseExpression whereClausePart,
boolean ignoreCase,
- Adapter db)
+ Adapter adapter)
throws TorqueException
{
PreparedStatementPart result =
getObjectOrColumnPsPartBuilder().buildPs(
- whereClausePart.getLValue(), ignoreCase, db);
+ whereClausePart.getLValue(), ignoreCase, adapter);
result.getSql().append(whereClausePart.getOperator());
result.append(getObjectOrColumnPsPartBuilder().buildPs(
- whereClausePart.getRValue(), ignoreCase, db));
+ whereClausePart.getRValue(), ignoreCase, adapter));
return result;
}
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/WhereClausePsPartBuilder.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/WhereClausePsPartBuilder.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/WhereClausePsPartBuilder.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/WhereClausePsPartBuilder.java
Fri Sep 21 19:59:16 2012
@@ -34,7 +34,7 @@ public interface WhereClausePsPartBuilde
/**
* Builds a PreparedStatementPart from a WhereClauseExpression.
*
- * @param whereClausePart the part of the where clause to build.
+ * @param whereClauseExpression the part of the where clause to build.
* Can be modified in this method.
* @param ignoreCase If true and columns represent Strings, the appropriate
* function defined for the database will be used to ignore
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeer.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeer.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeer.java
Fri Sep 21 19:59:16 2012
@@ -552,10 +552,6 @@ public abstract class BasePeer implement
*
* @return the number of affected rows.
*
- * @param updateValues A map keyed by the column names
- * containing the column's values in its values.
- * @param connection the database connection to use.
- *
* @throws TorqueException Any exceptions caught during processing will be
* rethrown wrapped into a TorqueException.
*/
@@ -572,7 +568,8 @@ public abstract class BasePeer implement
* are selected using <code>criteria</code> and updated using the values
* in <code>updateValues</code>.
*
- * @param criteria selects which rows of which table should be updated.
+ * @param selectCriteria selects which rows of which table
+ * should be updated, not null.
* @param updateValues Which columns to update with which values, not null.
*
* @return the number of affected rows.
@@ -597,7 +594,8 @@ public abstract class BasePeer implement
* are selected using <code>criteria</code> and updated using the values
* in <code>updateValues</code>.
*
- * @param criteria selects which rows of which table should be updated.
+ * @param selectCriteria selects which rows of which table
+ * should be updated, not null.
* @param updateValues Which columns to update with which values, not null.
*
* @return the number of affected rows.
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java
Fri Sep 21 19:59:16 2012
@@ -1363,9 +1363,6 @@ public class BasePeerImpl<T> implements
* @param criteria A Criteria specifying the records to select, not null.
* @param mapper The mapper creating the objects from the resultSet,
* not null.
- * @param defaultTableMap The table map used for the
- * unqualified columns in the query, or null in the case that
- * the table to select from need not be added to the query.
* @param connection the database connection for selecting records,
* not null.
*
@@ -1800,10 +1797,6 @@ public class BasePeerImpl<T> implements
*
* @return the number of affected rows.
*
- * @param updateValues A map keyed by the column names
- * containing the column's values in its values.
- * @param connection the database connection to use.
- *
* @throws TorqueException Any exceptions caught during processing will be
* rethrown wrapped into a TorqueException.
*/
@@ -1834,7 +1827,8 @@ public class BasePeerImpl<T> implements
* are selected using <code>criteria</code> and updated using the values
* in <code>updateValues</code>.
*
- * @param criteria selects which rows of which table should be updated.
+ * @param selectCriteria selects which rows of which table
+ * should be updated, not null.
* @param updateValues Which columns to update with which values, not null.
*
* @return the number of affected rows.
@@ -1879,7 +1873,8 @@ public class BasePeerImpl<T> implements
* are selected using <code>criteria</code> and updated using the values
* in <code>updateValues</code>.
*
- * @param criteria selects which rows of which table should be updated.
+ * @param selectCriteria selects which rows of which table
+ * should be updated, not null.
* @param updateValues Which columns to update with which values, not null.
*
* @return the number of affected rows.
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/JdbcTypedValue.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/JdbcTypedValue.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/JdbcTypedValue.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/JdbcTypedValue.java
Fri Sep 21 19:59:16 2012
@@ -68,9 +68,9 @@ public class JdbcTypedValue
}
/**
- * Sets the value.
+ * Returns the value.
*
- * @return the value, may be null.
+ * @return value the value, or null.
*/
public Object getValue()
{
@@ -78,9 +78,9 @@ public class JdbcTypedValue
}
/**
- * Returns the value.
+ * Sets the value.
*
- * @return value the value, or null.
+ * @param value the value, may be null.
*/
public void setValue(Object value)
{
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java
Fri Sep 21 19:59:16 2012
@@ -86,7 +86,6 @@ import org.apache.torque.util.functions.
* This will also work with joined tables if the criteria is creates as
* to create valid SQL.</p>
*
- * @see org.apache.torque.util.functions.FunctionFactory
* @author <a href="mailto:[email protected]";>Greg Monroe</a>
* @version $Id$
*/
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Avg.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Avg.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Avg.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Avg.java
Fri Sep 21 19:59:16 2012
@@ -42,7 +42,7 @@ public class Avg extends AggregateFuncti
/**
* Construct an AVG function class with an SQL expression to average over.
*
- * @param column the SQL expression to average over.
+ * @param sqlExpression the SQL expression to average over.
*/
public Avg(String sqlExpression)
{
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Count.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Count.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Count.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Count.java
Fri Sep 21 19:59:16 2012
@@ -42,7 +42,7 @@ public class Count extends AggregateFunc
/**
* Construct an COUNT function class with an SQL expression to count.
*
- * @param column the SQL expression to count.
+ * @param sqlExpression the SQL expression to count.
*/
public Count(String sqlExpression)
{
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Max.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Max.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Max.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Max.java
Fri Sep 21 19:59:16 2012
@@ -44,7 +44,7 @@ public class Max extends AggregateFuncti
* Construct an MAX function class with an SQL expression to calculate
* the maximum from.
*
- * @param column the SQL expression to calculate the maximum from.
+ * @param sqlExpression the SQL expression to calculate the maximum from.
*/
public Max(String sqlExpression)
{
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Min.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Min.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Min.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Min.java
Fri Sep 21 19:59:16 2012
@@ -44,7 +44,7 @@ public class Min extends AggregateFuncti
* Construct an MIN function class with an SQL expression to calculate
* the minimum from.
*
- * @param column the SQL expression to calculate the minimum from.
+ * @param sqlExpression the SQL expression to calculate the minimum from.
*/
public Min(String sqlExpression)
{
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/SQLFunction.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/SQLFunction.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/SQLFunction.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/SQLFunction.java
Fri Sep 21 19:59:16 2012
@@ -28,10 +28,8 @@ import org.apache.torque.Column;
* with the DBAdaptors. As well as allowing for functions to
* expand as needed.
*
- * @see FunctionFactory
- *
* @author <a href="mailto:[email protected]";>Greg Monroe</a>
- * @version $Id
+ * @version $Id$
*/
public interface SQLFunction extends Column
{
Modified:
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Sum.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Sum.java?rev=1388656&r1=1388655&r2=1388656&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Sum.java
(original)
+++
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/functions/Sum.java
Fri Sep 21 19:59:16 2012
@@ -42,7 +42,7 @@ public class Sum extends AggregateFuncti
/**
* Construct an SUM function class with an SQL expression to sum over.
*
- * @param column the SQL expression to sum over.
+ * @param sqlExpression the SQL expression to sum over.
*/
public Sum(String sqlExpression)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
