db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From an...@apache.org
Subject svn commit: r1684723 - /db/jdo/trunk/api/src/java/javax/jdo/Query.java
Date Wed, 10 Jun 2015 17:49:14 GMT
Author: andyj
Date: Wed Jun 10 17:49:14 2015
New Revision: 1684723

URL: http://svn.apache.org/r1684723
Log:
Fix for javadocs

Modified:
    db/jdo/trunk/api/src/java/javax/jdo/Query.java

Modified: db/jdo/trunk/api/src/java/javax/jdo/Query.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/Query.java?rev=1684723&r1=1684722&r2=1684723&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/Query.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/Query.java Wed Jun 10 17:49:14 2015
@@ -83,6 +83,8 @@ import java.util.Map;
  * <P>Any parameters passed to the <code>execute</code> methods are used
only 
  * for this execution, and are not remembered for future execution.
  * @version 2.1
+ * 
+ * @param T Candidate class for the query
  */
 public interface Query<T> extends AutoCloseable, Serializable {
 
@@ -798,7 +800,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the filter for the query.
-     * Shortcut for the {@link setFilter(String)} method
+     * Shortcut for the {@link #setFilter(String)} method
      * @param filter the query filter.
      * @return This query
      */
@@ -806,7 +808,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the ordering specification for the result <code>Collection</code>.
-     * Shortcut for the {@link setOrdering(String)} method
+     * Shortcut for the {@link #setOrdering(String)} method
      * @param ordering the ordering specification.
      * @return This query
      */
@@ -814,7 +816,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the grouping expressions, optionally including a "having" clause.
-     * Shortcut for the {@link setGrouping(String)} method
+     * Shortcut for the {@link #setGrouping(String)} method
      * @param group a comma-delimited list of expressions, optionally followed by the "having"
keyword and a boolean expression
      * @return This query
      */
@@ -829,7 +831,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the result clause for the query.
-     * Shortcut for the {@link setResult(String)} method
+     * Shortcut for the {@link #setResult(String)} method
      * @param result The result clause
      * @return This query
      */
@@ -837,7 +839,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the range of results to return.
-     * Shortcut for the {@link setRange(long, long)} method
+     * Shortcut for the {@link #setRange(long, long)} method
      * @param fromIncl 0-based inclusive start index
      * @param toExcl 0-based exclusive end index, or {@link Long#MAX_VALUE} for no limit.
      * @return This query
@@ -846,7 +848,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the range of results to return.
-     * Shortcut for the {@link setRange(String)} method
+     * Shortcut for the {@link #setRange(String)} method
      * @param fromInclToExcl comma-separated fromIncl and toExcl values
      * @return This query
      */
@@ -854,67 +856,74 @@ public interface Query<T> extends AutoCl
 
     /**
      * Add a subquery to this query.
-     * Shortcut for the {@link subquery(Query, String, String)} method
+     * Shortcut for the {@link #subquery(Query, String, String)} method
      * @param sub the subquery to add to this Query
      * @param variableDeclaration the name of the variable in the outer query to bind the
results of the subquery
      * @param candidateCollectionExpression the candidate collection of the subquery as an
expression using terms of the outer query
+     * @return This query
      */
     Query<T> subquery(Query sub, String variableDeclaration, String candidateCollectionExpression);
 
     /**
      * Add a subquery to this query.
-     * Shortcut for the {@link subquery(Query, String, String, String)} method
+     * Shortcut for the {@link #subquery(Query, String, String, String)} method
      * @param sub the subquery to add to this Query
      * @param variableDeclaration the name of the variable to be used in this Query
      * @param candidateCollectionExpression the candidate collection to apply to the subquery
      * @param parameter the expression from the outer query to bind the parameter in the
subquery
+     * @return This query
      */
     Query<T> subquery(Query sub, String variableDeclaration, String candidateCollectionExpression,
String parameter);
 
     /**
      * Add a subquery to this query.
-     * Shortcut for the {@link subquery(Query, String, String, String...)} method
+     * Shortcut for the {@link #subquery(Query, String, String, String...)} method
      * @param sub the subquery to add to this Query
      * @param variableDeclaration the name of the variable in the outer query to bind the
results of the subquery
      * @param candidateCollectionExpression the candidate collection of the subquery as an
expression using terms of the outer query
      * @param parameters the expressions from the outer query to bind the parameters in the
subquery
+     * @return This query
      */
     Query<T> subquery(Query sub, String variableDeclaration, String candidateCollectionExpression,
String... parameters);
 
     /**
      * Add a subquery to this query.
-     * Shortcut for the {@link subquery(Query, String, String, Map)} method
+     * Shortcut for the {@link #subquery(Query, String, String, Map)} method
      * @param sub the subquery to add to this Query
      * @param variableDeclaration the name of the variable to be used in this Query
      * @param candidateCollectionExpression the candidate collection to apply to the subquery
      * @param parameters the expressions from the outer query to bind the parameter in the
subquery
+     * @return This query
      */
     Query<T> subquery(Query sub, String variableDeclaration, String candidateCollectionExpression,
Map parameters);
 
     /**
      * Set the import statements to be used to identify the fully qualified name of variables
or parameters. 
-     * Shortcut for {@link declareImports(String)} method.
-     * @param parameters the list of parameters separated by commas.
+     * Shortcut for {@link #declareImports(String)} method.
+     * @param imports the imports declaration
+     * @return This query
      */
     Query<T> imports(String imports);
     
     /**
      * Declare the list of parameters for query execution.
-     * Shortcut for {@link declareParameters(String)} method.
+     * Shortcut for {@link #declareParameters(String)} method.
      * @param parameters the list of parameters separated by commas.
+     * @return This query
      */
     Query<T> parameters(String parameters);
     
     /**
      * Declare the unbound variables to be used in the query.
-     * Shortcut for {@link declareVariables(String)} method.
+     * Shortcut for {@link #declareVariables(String)} method.
      * @param variables the variables separated by semicolons.
+     * @return This query
      */
     Query<T> variables(String variables);
 
     /**
      * Set the datastore read timeout (millis).
-     * Shortcut for {@link setDatastoreReadTimeoutMillis(Integer)} method.
+     * Shortcut for {@link #setDatastoreReadTimeoutMillis(Integer)} method.
      * @param interval The interval
      * @return This query
      */
@@ -922,7 +931,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set the datastore write timeout (millis).
-     * Shortcut for {@link setDatastoreWriteTimeoutMillis(Integer)} method.
+     * Shortcut for {@link #setDatastoreWriteTimeoutMillis(Integer)} method.
      * @param interval The interval
      * @return This query
      */
@@ -930,7 +939,7 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set whether we to lock all objects read by this query.
-     * Shortcut for {@link setSerializeRead(Boolean)} method.
+     * Shortcut for {@link #setSerializeRead(Boolean)} method.
      * @param serialize Whether to lock
      * @return This query
      */
@@ -938,14 +947,14 @@ public interface Query<T> extends AutoCl
 
     /**
      * Set whether to make this query unmodifiable.
-     * Shortcut for {@link setUnmodifiable()} method.
+     * Shortcut for {@link #setUnmodifiable()} method.
      * @return This query
      */
     Query<T> unmodifiable();
 
     /**
      * Set whether we to ignore the cache with this query.
-     * Shortcut for {@link setIgnoreCache(boolean)} method.
+     * Shortcut for {@link #setIgnoreCache(boolean)} method.
      * @param flag Whether to ignore the cache
      * @return This query
      */
@@ -953,14 +962,17 @@ public interface Query<T> extends AutoCl
 
     /**
      * Specify an extension for this query.
-     * Shortcut for {@link addExtension(String, Object)} method.
+     * Shortcut for {@link #addExtension(String, Object)} method.
+     * @param key The extension key
+     * @param value The extension value
      * @return This query
      */
     Query<T> extension(String key, Object value);
 
     /**
      * Specify a map of extensions for this query.
-     * Shortcut for {@link setExtension(Map)} method.
+     * Shortcut for {@link #setExtensions(Map)} method.
+     * @param values The extension map of keys and values
      * @return This query
      */
     Query<T> extensions(Map values);



Mime
View raw message