CodeCow/querydsl
1
0
Fork 0
mirror of https://github.com/querydsl/querydsl.git synced 2026-07-03 21:07:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve JDO javadocs

Browse Source
This commit is contained in:
John Tims 2015-05-05 00:05:57 -04:00
parent 63400735b0
commit ed94a998bf
11 changed files with 35 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
querydsl-jdo/src/main/java/com/querydsl/jdo/AbstractJDOQuery.java
View File

@ -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;
@ -278,7 +279,7 @@ public abstract class AbstractJDOQuery<T, Q extends AbstractJDOQuery<T, Q>> 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.

18
querydsl-jdo/src/main/java/com/querydsl/jdo/JDOExpressions.java
View File

@ -24,7 +24,7 @@ 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 projection
* @param <T>
@ -35,7 +35,7 @@ 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 exprs projection
* @return select(exprs)
@ -45,29 +45,29 @@ 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 projection
* @param <T>
* @return select(distinct expr)
*/
public static <T> JDOQuery<T> selectDistinct(Expression<T> expr) {
return new JDOQuery<Void>().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 projection
* @return select(distinct exprs)
*/
public static JDOQuery<Tuple> selectDistinct(Expression<?>... exprs) {
return new JDOQuery<Void>().select(exprs).distinct();
return select(exprs).distinct();
}
/**
* Create a new detached JDOQuery instance with the given projection 0
* Create a new detached {@link JDOQuery} instance with the given projection 0
*
* @return select(0)
*/
@ -76,7 +76,7 @@ public final class JDOExpressions {
}
/**
* Create a new detached JDOQuery instance with the projection 1
* Create a new detached {@link JDOQuery} instance with the projection 1
*
* @return select(1)
*/
@ -85,7 +85,7 @@ 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 projection and source
* @param <T>

2
querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLQuery.java
View File

@ -62,7 +62,7 @@ public interface JDOQLQuery<T> extends FetchableQuery<T, JDOQLQuery<T>>, Query<J
/**
* Add the fetch group to the set of active fetch groups.
*
* @param fetchGroupName fetch group name
* @param fetchGroupName fetch group name
* @return the current object
*/
JDOQLQuery<T> addFetchGroup(String fetchGroupName);

2
querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQLSerializer.java
View File

@ -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
*

14
querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQuery.java
View File

@ -21,7 +21,7 @@ import com.querydsl.core.Tuple;
import com.querydsl.core.types.Expression;
/**
* {@code JDOQuery} is the default implementation of the JDOQLQuery interface
* {@code JDOQuery} is the default implementation of the {@link JDOQLQuery} interface
*
* @author tiwe
*
@ -30,7 +30,7 @@ import com.querydsl.core.types.Expression;
public class JDOQuery<T> extends AbstractJDOQuery<T, JDOQuery<T>> {
/**
* Create a detached JDOQuery instance
* Create a detached {@link JDOQuery} instance
* The query can be attached via the clone method
*
*/
@ -39,7 +39,7 @@ public class JDOQuery<T> extends AbstractJDOQuery<T, JDOQuery<T>> {
}
/**
* Create a new JDOQuery instance
* Create a new {@link JDOQuery} instance
*
* @param persistenceManager PersistenceManager instance to use
* @param templates JDOQLTemplates to use
@ -50,7 +50,7 @@ public class JDOQuery<T> extends AbstractJDOQuery<T, JDOQuery<T>> {
}
/**
* Create a new JDOQuery instance
* Create a new {@link JDOQuery} instance
*
* @param persistenceManager PersistenceManager instance to use
* @param detach detached results or not
@ -60,7 +60,7 @@ public class JDOQuery<T> extends AbstractJDOQuery<T, JDOQuery<T>> {
}
/**
* Create a new JDOQuery instance
* Create a new {@link JDOQuery} instance
*
* @param persistenceManager PersistenceManager instance to use
*/
@ -69,7 +69,7 @@ public class JDOQuery<T> extends AbstractJDOQuery<T, JDOQuery<T>> {
}
/**
* Create a new JDOQuery instance
* Create a new {@link JDOQuery} instance
*
* @param persistenceManager PersistenceManager instance to use
* @param templates templates to use
@ -82,7 +82,7 @@ public class JDOQuery<T> extends AbstractJDOQuery<T, JDOQuery<T>> {
}
/**
* 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 PersistenceManager instance to use
* @return cloned query

14
querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryFactory.java
View File

@ -42,7 +42,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the given projection
* Create a new {@link JDOQuery} instance with the given projection
*
* @param expr projection
* @param <T>
@ -53,7 +53,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the given projection
* Create a new {@link JDOQuery} instance with the given projection
*
* @param exprs projection
* @return select(exprs)
@ -63,7 +63,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the given projection
* Create a new {@link JDOQuery} instance with the given projection
*
* @param expr projection
* @param <T>
@ -74,7 +74,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the given projection
* Create a new {@link JDOQuery} instance with the given projection
*
* @param exprs projection
* @return select(distinct exprs)
@ -84,7 +84,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the projection zero
* Create a new {@link JDOQuery} instance with the projection 0
*
* @return select(0)
*/
@ -93,7 +93,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the projection one
* Create a new {@link JDOQuery} instance with the projection 1
*
* @return select(1)
*/
@ -102,7 +102,7 @@ public class JDOQueryFactory implements QueryFactory<JDOQuery<?>> {
}
/**
* Create a new JDOQuery instance with the given projection
* Create a new {@link JDOQuery} instance with the given projection
*
* @param expr projection and source
* @param <T>

2
querydsl-jdo/src/main/java/com/querydsl/jdo/JDOQueryMixin.java
View File

@ -19,7 +19,7 @@ import com.querydsl.core.support.QueryMixin;
import com.querydsl.core.types.*;
/**
* {@code JDOQueryMixin} extends {@link QueryMixin} to provide module specific extensions
* {@code JDOQueryMixin} extends {@link QueryMixin} to provide module-specific extensions
*
* @author tiwe
*

2
querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDODeleteClause.java
View File

@ -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
*

2
querydsl-jdo/src/main/java/com/querydsl/jdo/dml/JDOUpdateClause.java
View File

@ -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
*

5
querydsl-jdo/src/main/java/com/querydsl/jdo/sql/AbstractSQLQuery.java
View File

@ -36,10 +36,11 @@ 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
*
@ -117,7 +118,7 @@ public abstract class AbstractSQLQuery<T, Q extends AbstractSQLQuery<T, Q>> 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);

3
querydsl-jdo/src/main/java/com/querydsl/jdo/sql/JDOSQLQuery.java
View File

@ -21,11 +21,12 @@ 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