Javadoc fixes.
This commit is contained in:
@@ -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}.
|
||||
*/
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -437,7 +437,7 @@ public class DepotMarshaller<T extends PersistentRecord>
|
||||
|
||||
/**
|
||||
* 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
|
||||
|
||||
@@ -232,7 +232,7 @@ public abstract class DepotRepository
|
||||
}
|
||||
|
||||
/**
|
||||
* A varargs version of {@link #findAll(Class<T>,Collection<QueryClause>)}.
|
||||
* A varargs version of {@link #findAll(Class,Collection)}.
|
||||
*/
|
||||
protected <T extends PersistentRecord> List<T> findAll (Class<T> type, QueryClause... clauses)
|
||||
throws DatabaseException
|
||||
|
||||
@@ -68,7 +68,7 @@ public class DepotTypes
|
||||
}
|
||||
|
||||
/**
|
||||
* A varargs version of {@link #getDepotTypes(PersistenceContext,Collection<QueryClause>)}.
|
||||
* A varargs version of {@link #getDepotTypes(PersistenceContext,Collection)}.
|
||||
*/
|
||||
public static <T extends PersistentRecord> DepotTypes getDepotTypes (
|
||||
PersistenceContext ctx, QueryClause... clauses)
|
||||
|
||||
@@ -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<T extends PersistentRecord>
|
||||
implements Query<List<T>>
|
||||
{
|
||||
/**
|
||||
* 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<T extends PersistentRecord> extends FindAllQuery<T>
|
||||
{
|
||||
@@ -117,7 +118,8 @@ public abstract class FindAllQuery<T extends PersistentRecord>
|
||||
}
|
||||
|
||||
/**
|
||||
* 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<T extends PersistentRecord> extends FindAllQuery<T>
|
||||
{
|
||||
@@ -155,7 +157,8 @@ public abstract class FindAllQuery<T extends PersistentRecord>
|
||||
}
|
||||
|
||||
/**
|
||||
* 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<T extends PersistentRecord> extends FindAllQuery<T>
|
||||
{
|
||||
|
||||
@@ -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<T extends PersistentRecord>
|
||||
implements Query<T>
|
||||
|
||||
@@ -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.
|
||||
*/
|
||||
|
||||
@@ -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<T extends PersistentRecord> extends WhereClause
|
||||
implements ValidatingCacheInvalidator
|
||||
@@ -64,7 +64,7 @@ public class MultiKey<T extends PersistentRecord> 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<T> pClass, String[] sFields, Comparable<?>[] sValues,
|
||||
String mField, Comparable<?>[] mValues)
|
||||
|
||||
@@ -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<T extends Serializable>
|
||||
implements CacheTraverser<T>
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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 <T extends PersistentRecord> boolean addFullTextSearch (
|
||||
Connection conn, DepotMarshaller<T> marshaller, FullTextIndex fts)
|
||||
|
||||
@@ -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.
|
||||
*
|
||||
* <p> 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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user