From 4c94296b679abb6fc25fe8e5a0ae0d7e5bc98ddd Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Tue, 30 Sep 2008 00:12:08 +0000 Subject: [PATCH] Javadoc fixes. --- src/java/com/samskivert/jdbc/depot/BindVisitor.java | 2 +- .../com/samskivert/jdbc/depot/CacheInvalidator.java | 2 +- .../com/samskivert/jdbc/depot/DepotMarshaller.java | 2 +- .../com/samskivert/jdbc/depot/DepotRepository.java | 2 +- src/java/com/samskivert/jdbc/depot/DepotTypes.java | 2 +- src/java/com/samskivert/jdbc/depot/FindAllQuery.java | 11 +++++++---- src/java/com/samskivert/jdbc/depot/FindOneQuery.java | 2 +- src/java/com/samskivert/jdbc/depot/Modifier.java | 4 ++-- src/java/com/samskivert/jdbc/depot/MultiKey.java | 4 ++-- .../com/samskivert/jdbc/depot/PersistenceContext.java | 2 +- src/java/com/samskivert/jdbc/depot/Query.java | 1 + src/java/com/samskivert/jdbc/depot/SQLBuilder.java | 5 +++-- .../com/samskivert/jdbc/depot/SchemaMigration.java | 3 ++- .../samskivert/jdbc/depot/annotation/Computed.java | 3 +++ 14 files changed, 27 insertions(+), 18 deletions(-) diff --git a/src/java/com/samskivert/jdbc/depot/BindVisitor.java b/src/java/com/samskivert/jdbc/depot/BindVisitor.java index 7acdcb7..43d9dbd 100644 --- a/src/java/com/samskivert/jdbc/depot/BindVisitor.java +++ b/src/java/com/samskivert/jdbc/depot/BindVisitor.java @@ -56,7 +56,7 @@ import com.samskivert.util.StringUtil; /** * Implements the base functionality of the argument-binding pass of {@link SQLBuilder}. Dialectal - * subclasses of this should be created and returned from {@link SQLBuilder#getBindVisitor()}. + * subclasses of this should be created and returned from {@link SQLBuilder#getBindVisitor}. * * This class is intimately paired with {#link BuildVisitor}. */ diff --git a/src/java/com/samskivert/jdbc/depot/CacheInvalidator.java b/src/java/com/samskivert/jdbc/depot/CacheInvalidator.java index 075a791..525ef60 100644 --- a/src/java/com/samskivert/jdbc/depot/CacheInvalidator.java +++ b/src/java/com/samskivert/jdbc/depot/CacheInvalidator.java @@ -25,7 +25,7 @@ import java.io.Serializable; /** * Implementors of this interface performs perform cache invalidation for calls to * {@link DepotRepository#updateLiteral}, {@link DepotRepository#updatePartial} and - * {@link DepotRepository#deleteAll). + * {@link DepotRepository#deleteAll}. */ public interface CacheInvalidator { diff --git a/src/java/com/samskivert/jdbc/depot/DepotMarshaller.java b/src/java/com/samskivert/jdbc/depot/DepotMarshaller.java index ac517de..61b0cde 100644 --- a/src/java/com/samskivert/jdbc/depot/DepotMarshaller.java +++ b/src/java/com/samskivert/jdbc/depot/DepotMarshaller.java @@ -437,7 +437,7 @@ public class DepotMarshaller /** * Creates a persistent object from the supplied result set. The result set must have come from - * a query provided by {@link #createQuery}. + * a properly constructed query (see {@link BuildVisitor}). */ public T createObject (ResultSet rs) throws SQLException diff --git a/src/java/com/samskivert/jdbc/depot/DepotRepository.java b/src/java/com/samskivert/jdbc/depot/DepotRepository.java index 8bc7ddc..05af9ca 100644 --- a/src/java/com/samskivert/jdbc/depot/DepotRepository.java +++ b/src/java/com/samskivert/jdbc/depot/DepotRepository.java @@ -232,7 +232,7 @@ public abstract class DepotRepository } /** - * A varargs version of {@link #findAll(Class,Collection)}. + * A varargs version of {@link #findAll(Class,Collection)}. */ protected List findAll (Class type, QueryClause... clauses) throws DatabaseException diff --git a/src/java/com/samskivert/jdbc/depot/DepotTypes.java b/src/java/com/samskivert/jdbc/depot/DepotTypes.java index 4cffe24..c0ff4e9 100644 --- a/src/java/com/samskivert/jdbc/depot/DepotTypes.java +++ b/src/java/com/samskivert/jdbc/depot/DepotTypes.java @@ -68,7 +68,7 @@ public class DepotTypes } /** - * A varargs version of {@link #getDepotTypes(PersistenceContext,Collection)}. + * A varargs version of {@link #getDepotTypes(PersistenceContext,Collection)}. */ public static DepotTypes getDepotTypes ( PersistenceContext ctx, QueryClause... clauses) diff --git a/src/java/com/samskivert/jdbc/depot/FindAllQuery.java b/src/java/com/samskivert/jdbc/depot/FindAllQuery.java index b9bd0f9..8d559d0 100644 --- a/src/java/com/samskivert/jdbc/depot/FindAllQuery.java +++ b/src/java/com/samskivert/jdbc/depot/FindAllQuery.java @@ -45,14 +45,15 @@ import com.samskivert.jdbc.depot.operator.Conditionals.*; import static com.samskivert.jdbc.depot.Log.log; /** - * This class implements the functionality required by {@link DepotRepository#findAll): fetch + * This class implements the functionality required by {@link DepotRepository#findAll}: fetch * a collection of persistent objects using one of two included strategies. */ public abstract class FindAllQuery implements Query> { /** - * The two-pass collection query implementation. {@see DepotRepository#findAll} for details. + * The two-pass collection query implementation. See {@link DepotRepository#findAll} for + * details. */ public static class WithCache extends FindAllQuery { @@ -117,7 +118,8 @@ public abstract class FindAllQuery } /** - * The two-pass collection query implementation. {@see DepotRepository#findAll} for details. + * The two-pass collection query implementation. See {@link DepotRepository#findAll} for + * details. */ public static class WithKeys extends FindAllQuery { @@ -155,7 +157,8 @@ public abstract class FindAllQuery } /** - * The single-pass collection query implementation. {@see DepotRepository#findAll} for details. + * The single-pass collection query implementation. See {@link DepotRepository#findAll} for + * details. */ public static class Explicitly extends FindAllQuery { diff --git a/src/java/com/samskivert/jdbc/depot/FindOneQuery.java b/src/java/com/samskivert/jdbc/depot/FindOneQuery.java index a9b82f9..5cc449a 100644 --- a/src/java/com/samskivert/jdbc/depot/FindOneQuery.java +++ b/src/java/com/samskivert/jdbc/depot/FindOneQuery.java @@ -31,7 +31,7 @@ import com.samskivert.jdbc.depot.clause.QueryClause; import com.samskivert.jdbc.depot.clause.SelectClause; /** - * The implementation of {@link DepotRepository#find) functionality. + * The implementation of {@link DepotRepository#load} functionality. */ public class FindOneQuery implements Query diff --git a/src/java/com/samskivert/jdbc/depot/Modifier.java b/src/java/com/samskivert/jdbc/depot/Modifier.java index 44c1e9f..c5c4baa 100644 --- a/src/java/com/samskivert/jdbc/depot/Modifier.java +++ b/src/java/com/samskivert/jdbc/depot/Modifier.java @@ -55,8 +55,8 @@ public abstract class Modifier /** * A convenience modifier that can perform cache updates in addition to invalidation: - * - Before {@link #invoke(Connection)}, the {@link CacheInvalidator} is run, if given. - * - After {@link #invoke(Connection)}, the cache is updated with the modified object, + * - Before {@link #invoke}, the {@link CacheInvalidator} is run, if given. + * - After {@link #invoke}, the cache is updated with the modified object, * presuming both _key and _result are non-null. These variables may be set or modified * during execution in addition to being supplied to the constructor. */ diff --git a/src/java/com/samskivert/jdbc/depot/MultiKey.java b/src/java/com/samskivert/jdbc/depot/MultiKey.java index 3b1d74f..d1fe8aa 100644 --- a/src/java/com/samskivert/jdbc/depot/MultiKey.java +++ b/src/java/com/samskivert/jdbc/depot/MultiKey.java @@ -31,7 +31,7 @@ import com.samskivert.jdbc.depot.expression.SQLExpression; /** * A special form of {@link Where} clause that specifies an explicit range of database rows. It * does not implement {@link CacheKey} but it does implement {@link CacheInvalidator} which means - * it can be sent into e.g. {@link DepotRepository#deleteAll) and have it clean up after itself. + * it can be sent into e.g. {@link DepotRepository#deleteAll} and have it clean up after itself. */ public class MultiKey extends WhereClause implements ValidatingCacheInvalidator @@ -64,7 +64,7 @@ public class MultiKey extends WhereClause /** * Constructs a new multi-column {@code MultiKey} with the given value range. - * @TODO: See {@link Key#Key(Class, String[], Comparable[]) for somewhat relevant comments. + * See {@link Key#Key(Class,String[],Comparable[])} for somewhat relevant comments. */ public MultiKey (Class pClass, String[] sFields, Comparable[] sValues, String mField, Comparable[] mValues) diff --git a/src/java/com/samskivert/jdbc/depot/PersistenceContext.java b/src/java/com/samskivert/jdbc/depot/PersistenceContext.java index 810444c..e0751a2 100644 --- a/src/java/com/samskivert/jdbc/depot/PersistenceContext.java +++ b/src/java/com/samskivert/jdbc/depot/PersistenceContext.java @@ -95,7 +95,7 @@ public class PersistenceContext /** * A simple implementation of {@link CacheTraverser} that selectively deletes entries in - * a cache depending on the return value of {@link #testCacheEntry}. + * a cache depending on the return value of {@link #testForEviction}. */ public static abstract class CacheEvictionFilter implements CacheTraverser diff --git a/src/java/com/samskivert/jdbc/depot/Query.java b/src/java/com/samskivert/jdbc/depot/Query.java index bb182b3..d49a650 100644 --- a/src/java/com/samskivert/jdbc/depot/Query.java +++ b/src/java/com/samskivert/jdbc/depot/Query.java @@ -24,6 +24,7 @@ import java.sql.Connection; import java.sql.SQLException; import com.samskivert.jdbc.DatabaseLiaison; +import com.samskivert.jdbc.depot.PersistenceContext.CacheListener; /** * The base of all read-only queries. diff --git a/src/java/com/samskivert/jdbc/depot/SQLBuilder.java b/src/java/com/samskivert/jdbc/depot/SQLBuilder.java index 9880fcd..1b71373 100644 --- a/src/java/com/samskivert/jdbc/depot/SQLBuilder.java +++ b/src/java/com/samskivert/jdbc/depot/SQLBuilder.java @@ -32,6 +32,7 @@ import com.samskivert.jdbc.depot.annotation.Column; import com.samskivert.jdbc.depot.annotation.FullTextIndex; import com.samskivert.jdbc.depot.annotation.GeneratedValue; import com.samskivert.jdbc.depot.clause.QueryClause; +import com.samskivert.jdbc.depot.expression.ExpressionVisitor; import static com.samskivert.jdbc.depot.Log.log; @@ -67,7 +68,7 @@ public abstract class SQLBuilder * that were defined in the generated SQL. * * This method throws {@link SQLException} and is thus meant to be called from within - * {@link Query#invoke(Connection)} and {@link Modifier#invoke(Connection)}. + * {@link Query#invoke} and {@link Modifier#invoke}. */ public PreparedStatement prepare (Connection conn) throws SQLException @@ -176,7 +177,7 @@ public abstract class SQLBuilder * the table associated with the given {@link DepotMarshaller}. This is a highly database * specific operation and must thus be implemented by each dialect subclass. * - * {@see Conditionals.FullTextIndex} + * @see FullTextIndex */ public abstract boolean addFullTextSearch ( Connection conn, DepotMarshaller marshaller, FullTextIndex fts) diff --git a/src/java/com/samskivert/jdbc/depot/SchemaMigration.java b/src/java/com/samskivert/jdbc/depot/SchemaMigration.java index a5b85a7..a42bb47 100644 --- a/src/java/com/samskivert/jdbc/depot/SchemaMigration.java +++ b/src/java/com/samskivert/jdbc/depot/SchemaMigration.java @@ -26,6 +26,7 @@ import java.util.Map; import com.samskivert.jdbc.ColumnDefinition; import com.samskivert.jdbc.DatabaseLiaison; +import com.samskivert.jdbc.depot.annotation.Column; import static com.samskivert.jdbc.depot.Log.log; @@ -33,7 +34,7 @@ import static com.samskivert.jdbc.depot.Log.log; * Encapsulates the migration of a persistent record's database schema. These can be registered * with the {@link PersistenceContext} to effect hand-coded migrations between entity versions. The * modifier should override {@link #invoke} to perform its migrations. See {@link - * PersistenceContext#registerPreMigration} for details on the migration process. + * PersistenceContext#registerMigration} for details on the migration process. * *

Note: these should only be used for actual schema changes (column additions, removals, * renames, retypes, etc.). It should not be used for data migration, use {@link DataMigration} for diff --git a/src/java/com/samskivert/jdbc/depot/annotation/Computed.java b/src/java/com/samskivert/jdbc/depot/annotation/Computed.java index 879ed0a..f7fe38c 100644 --- a/src/java/com/samskivert/jdbc/depot/annotation/Computed.java +++ b/src/java/com/samskivert/jdbc/depot/annotation/Computed.java @@ -26,6 +26,9 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import com.samskivert.jdbc.depot.PersistentRecord; +import com.samskivert.jdbc.depot.clause.FieldOverride; +import com.samskivert.jdbc.depot.clause.FromOverride; +import com.samskivert.jdbc.depot.clause.Join; /** * Marks a field as computed, meaning it is ignored for schema purposes and it does not directly