diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/AbstractJDOQuery.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/AbstractJDOQuery.java index d6ca27740..44553dc19 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/AbstractJDOQuery.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/AbstractJDOQuery.java @@ -18,6 +18,7 @@ import java.io.IOException; import java.util.*; import javax.annotation.Nullable; +import javax.jdo.JDOUserException; import javax.jdo.PersistenceManager; import javax.jdo.Query; @@ -31,14 +32,14 @@ import com.mysema.commons.lang.IteratorAdapter; import com.querydsl.core.*; import com.querydsl.core.support.FetchableSubQueryBase; import com.querydsl.core.types.*; -import com.querydsl.core.types.dsl.CollectionPath; /** - * Abstract base class for custom implementations of the JDOCommonQuery interface. + * Abstract base class for custom implementations of the {@link JDOQLQuery} interface. * * @author tiwe * - * @param + * @param result type + * @param concrete subclass */ public abstract class AbstractJDOQuery> extends FetchableSubQueryBase implements JDOQLQuery { @@ -89,8 +90,8 @@ public abstract class AbstractJDOQuery> exte /** * Add the fetch group to the set of active fetch groups. * - * @param fetchGroupName - * @return + * @param fetchGroupName fetch group name + * @return the current object */ @Override public Q addFetchGroup(String fetchGroupName) { @@ -278,13 +279,13 @@ public abstract class AbstractJDOQuery> exte /** * Set the maximum fetch depth when fetching. - * A value of 0 has no meaning and will throw a JDOUserException. + * A value of 0 has no meaning and will throw a {@link JDOUserException}. * A value of -1 means that no limit is placed on fetching. * A positive integer will result in that number of references from the * initial object to be fetched. * - * @param depth - * @return + * @param depth fetch depth + * @return the current object */ @Override public Q setMaxFetchDepth(int depth) { diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOExpressions.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOExpressions.java index 93d4be051..c60cf62d2 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOExpressions.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOExpressions.java @@ -24,70 +24,72 @@ import com.querydsl.core.types.dsl.Expressions; public final class JDOExpressions { /** - * Create a new detached JDOQuery instance with the given projection + * Create a new detached {@link JDOQuery} instance with the given projection * - * @param expr + * @param expr projection * @param - * @return + * @return select(expr) */ public static JDOQuery select(Expression expr) { return new JDOQuery().select(expr); } /** - * Create a new detached JDOQuery instance with the given projection + * Create a new detached {@link JDOQuery} instance with the given projection * - * @param exprs - * @return + * @param exprs projection + * @return select(exprs) */ public static JDOQuery select(Expression... exprs) { return new JDOQuery().select(exprs); } /** - * Create a new detached JDOQuery instance with the given projection + * Create a new detached {@link JDOQuery} instance with the given projection * - * @param expr + * @param expr projection * @param - * @return + * @return select(distinct expr) */ public static JDOQuery selectDistinct(Expression expr) { - return new JDOQuery().select(expr).distinct(); + return select(expr).distinct(); } /** - * Create a new detached JDOQuery instance with the given projection + * Create a new detached {@link JDOQuery} instance with the given projection * - * @param exprs - * @return + * @param exprs projection + * @return select(distinct exprs) */ public static JDOQuery selectDistinct(Expression... exprs) { - return new JDOQuery().select(exprs).distinct(); + return select(exprs).distinct(); } /** + * Create a new detached {@link JDOQuery} instance with the given projection 0 * - * @return + * @return select(0) */ public static JDOQuery selectZero() { return select(Expressions.ZERO); } /** + * Create a new detached {@link JDOQuery} instance with the projection 1 * - * @return + * @return select(1) */ public static JDOQuery selectOne() { return select(Expressions.ONE); } /** - * Create a new detached JDOQuery instance with the given projection + * Create a new detached {@link JDOQuery} instance with the given projection * - * @param expr + * @param expr projection and source * @param - * @return + * @return select(expr).from(expr) */ public static JDOQuery selectFrom(EntityPath expr) { return select(expr).from(expr); diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLQuery.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLQuery.java index 4be03428e..3e75c3ad2 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLQuery.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLQuery.java @@ -29,40 +29,41 @@ import com.querydsl.core.types.Path; * * @author tiwe * + * @param result type */ public interface JDOQLQuery extends FetchableQuery>, Query>, ExtendedSubQuery, Closeable { /** * Add query sources * - * @param sources - * @return + * @param sources sources + * @return the current object */ JDOQLQuery from(EntityPath... sources); /** * Add query sources * - * @param path - * @param alias + * @param path source + * @param alias alias * @param - * @return + * @return the current object */ JDOQLQuery from(CollectionExpression path, Path alias); /** * Clone the state of the query for the given PersistenceManager * - * @param persistenceManager - * @return + * @param persistenceManager persistence manager + * @return cloned query */ JDOQLQuery clone(PersistenceManager persistenceManager); /** * Add the fetch group to the set of active fetch groups. * - * @param fetchGroupName - * @return + * @param fetchGroupName fetch group name + * @return the current object */ JDOQLQuery addFetchGroup(String fetchGroupName); @@ -73,8 +74,8 @@ public interface JDOQLQuery extends FetchableQuery>, Query setMaxFetchDepth(int maxFetchDepth); diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLSerializer.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLSerializer.java index 0e8e078ad..b56524190 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLSerializer.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLSerializer.java @@ -27,7 +27,7 @@ import com.querydsl.core.types.*; import com.querydsl.core.types.dsl.Param; /** - * JDOQLSerializer serializes Querydsl queries and expressions into JDOQL strings + * {@code JDOQLSerializer} serializes Querydsl queries and expressions into JDOQL strings * * @author tiwe * @@ -273,7 +273,6 @@ public final class JDOQLSerializer extends SerializerBase { return null; } -// @SuppressWarnings({ "unchecked", "rawtypes" }) @Override protected void visitOperation(Class type, Operator operator, List> args) { if (operator == Ops.INSTANCE_OF) { diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLTemplates.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLTemplates.java index 231c3bba4..c3d440086 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLTemplates.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLTemplates.java @@ -17,7 +17,7 @@ import com.querydsl.core.types.JavaTemplates; import com.querydsl.core.types.Ops; /** - * JDOQLTemplates provides patterns for JDOQL serialization + * {@code JDOQLTemplates} provides patterns for JDOQL serialization * * @author tiwe * diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQuery.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQuery.java index 872f6c3ca..1d0198274 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQuery.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQuery.java @@ -21,15 +21,16 @@ import com.querydsl.core.Tuple; import com.querydsl.core.types.Expression; /** - * JDOQuery is the default implementation of the JDOQLQuery interface + * {@code JDOQuery} is the default implementation of the {@link JDOQLQuery} interface * * @author tiwe * + * @param result type */ public class JDOQuery extends AbstractJDOQuery> { /** - * Create a detached JDOQuery instance + * Create a detached {@link JDOQuery} instance * The query can be attached via the clone method * */ @@ -38,7 +39,7 @@ public class JDOQuery extends AbstractJDOQuery> { } /** - * Create a new JDOQuery instance + * Create a new {@link JDOQuery} instance * * @param persistenceManager PersistenceManager instance to use * @param templates JDOQLTemplates to use @@ -49,7 +50,7 @@ public class JDOQuery extends AbstractJDOQuery> { } /** - * Create a new JDOQuery instance + * Create a new {@link JDOQuery} instance * * @param persistenceManager PersistenceManager instance to use * @param detach detached results or not @@ -59,7 +60,7 @@ public class JDOQuery extends AbstractJDOQuery> { } /** - * Create a new JDOQuery instance + * Create a new {@link JDOQuery} instance * * @param persistenceManager PersistenceManager instance to use */ @@ -68,12 +69,12 @@ public class JDOQuery extends AbstractJDOQuery> { } /** - * Create a new JDOQuery instance + * Create a new {@link JDOQuery} instance * - * @param persistenceManager - * @param templates - * @param metadata - * @param detach + * @param persistenceManager PersistenceManager instance to use + * @param templates templates to use + * @param metadata query metadata + * @param detach detached results or not */ protected JDOQuery(PersistenceManager persistenceManager, JDOQLTemplates templates, QueryMetadata metadata, boolean detach) { @@ -81,10 +82,10 @@ public class JDOQuery extends AbstractJDOQuery> { } /** - * Clone the state of this query to a new JDOQuery instance with the given PersistenceManager + * Clone the state of this query to a new {@link JDOQuery} instance with the given {@link PersistenceManager} * - * @param persistenceManager - * @return + * @param persistenceManager PersistenceManager instance to use + * @return cloned query */ public JDOQuery clone(PersistenceManager persistenceManager) { JDOQuery query = new JDOQuery(persistenceManager, getTemplates(), diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryFactory.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryFactory.java index f1138fb81..5c998bbac 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryFactory.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryFactory.java @@ -42,69 +42,71 @@ public class JDOQueryFactory implements QueryFactory> { } /** - * Create a new JDOQuery instance with the given projection + * Create a new {@link JDOQuery} instance with the given projection * - * @param expr + * @param expr projection * @param - * @return + * @return select(expr) */ public JDOQuery select(Expression expr) { return query().select(expr); } /** - * Create a new JDOQuery instance with the given projection + * Create a new {@link JDOQuery} instance with the given projection * - * @param exprs - * @return + * @param exprs projection + * @return select(exprs) */ public JDOQuery select(Expression... exprs) { return query().select(exprs); } /** - * Create a new JDOQuery instance with the given projection + * Create a new {@link JDOQuery} instance with the given projection * - * @param expr + * @param expr projection * @param - * @return + * @return select(distinct expr) */ public JDOQuery selectDistinct(Expression expr) { return query().select(expr).distinct(); } /** - * Create a new JDOQuery instance with the given projection + * Create a new {@link JDOQuery} instance with the given projection * - * @param exprs - * @return + * @param exprs projection + * @return select(distinct exprs) */ public JDOQuery selectDistinct(Expression... exprs) { return query().select(exprs).distinct(); } /** + * Create a new {@link JDOQuery} instance with the projection 0 * - * @return + * @return select(0) */ public JDOQuery selectZero() { return select(Expressions.ZERO); } /** + * Create a new {@link JDOQuery} instance with the projection 1 * - * @return + * @return select(1) */ public JDOQuery selectOne() { return select(Expressions.ONE); } /** - * Create a new JDOQuery instance with the given projection + * Create a new {@link JDOQuery} instance with the given projection * - * @param expr + * @param expr projection and source * @param - * @return + * @return select(expr).from(expr) */ public JDOQuery selectFrom(EntityPath expr) { return select(expr).from(expr); diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryMixin.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryMixin.java index 6b6574987..24866abed 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryMixin.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryMixin.java @@ -19,7 +19,7 @@ import com.querydsl.core.support.QueryMixin; import com.querydsl.core.types.*; /** - * JDOQueryMixin extends {@link QueryMixin} to provide module specific extensions + * {@code JDOQueryMixin} extends {@link QueryMixin} to provide module-specific extensions * * @author tiwe * diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDODeleteClause.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDODeleteClause.java index 8c4542997..507b6fce8 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDODeleteClause.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDODeleteClause.java @@ -30,7 +30,7 @@ import com.querydsl.core.types.EntityPath; import com.querydsl.core.types.Predicate; /** - * DeleteClause implementation for JDO + * {@link DeleteClause} implementation for JDO * * @author tiwe * diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDOUpdateClause.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDOUpdateClause.java index 36e6ff2f3..31653397d 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDOUpdateClause.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDOUpdateClause.java @@ -26,7 +26,7 @@ import com.querydsl.core.types.Path; import com.querydsl.core.types.Predicate; /** - * UpdateClause implementation for JDO + * {@link UpdateClause} implementation for JDO * * @author tiwe * diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/AbstractSQLQuery.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/AbstractSQLQuery.java index 9ce3d10f6..c6e64125c 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/AbstractSQLQuery.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/AbstractSQLQuery.java @@ -36,14 +36,16 @@ import com.querydsl.core.types.Expression; import com.querydsl.core.types.FactoryExpression; import com.querydsl.sql.Configuration; import com.querydsl.sql.ProjectableSQLQuery; +import com.querydsl.sql.SQLQuery; import com.querydsl.sql.SQLSerializer; /** - * Base class for JDO based SQLQuery implementations + * Base class for JDO-based {@link SQLQuery} implementations * * @author tiwe * - * @param + * @param result type + * @param concrete subclass */ @SuppressWarnings("rawtypes") public abstract class AbstractSQLQuery> extends ProjectableSQLQuery { @@ -81,6 +83,9 @@ public abstract class AbstractSQLQuery> exte this.detach = detach; } + /** + * Close the query and related resources + */ public void close() { for (Query query : queries) { query.closeAll(); @@ -113,7 +118,7 @@ public abstract class AbstractSQLQuery> exte if (logger.isDebugEnabled()) { logger.debug(serializer.toString()); } - Query query = persistenceManager.newQuery("javax.jdo.query.SQL",serializer.toString()); + Query query = persistenceManager.newQuery("javax.jdo.query.SQL", serializer.toString()); orderedConstants = serializer.getConstants(); queries.add(query); @@ -144,7 +149,7 @@ public abstract class AbstractSQLQuery> exte } else if (row.getClass().isArray()) { return expr.newInstance((Object[])row); } else { - return expr.newInstance(new Object[]{row}); + return expr.newInstance(row); } } diff --git a/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/JDOSQLQuery.java b/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/JDOSQLQuery.java index baa04954d..44b3c2b07 100644 --- a/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/JDOSQLQuery.java +++ b/querydsl-jdo/src/main/java/com/querydsl/jdo/sql/JDOSQLQuery.java @@ -21,15 +21,18 @@ import com.querydsl.core.QueryMetadata; import com.querydsl.core.Tuple; import com.querydsl.core.types.Expression; import com.querydsl.sql.Configuration; +import com.querydsl.sql.SQLQuery; import com.querydsl.sql.SQLSerializer; import com.querydsl.sql.SQLTemplates; /** - * JDOSQLQuery is an SQLQuery implementation that uses JDO's SQL query functionality + * {@code JDOSQLQuery} is a {@link SQLQuery} implementation that uses JDO's SQL query functionality * to execute queries * * @author tiwe * + * @param result type + * */ public final class JDOSQLQuery extends AbstractSQLQuery> {