cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From amania...@apache.org
Subject cayenne git commit: Improve some javadocs
Date Tue, 16 Feb 2016 11:32:12 GMT
Repository: cayenne
Updated Branches:
  refs/heads/master fd7fc87b7 -> faa35546a


Improve some javadocs


Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo
Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/faa35546
Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/faa35546
Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/faa35546

Branch: refs/heads/master
Commit: faa35546a70faaf3d97ef7971e88af97a69a7856
Parents: fd7fc87
Author: Aristedes Maniatis <ari@ish.com.au>
Authored: Tue Feb 16 22:31:38 2016 +1100
Committer: Aristedes Maniatis <ari@ish.com.au>
Committed: Tue Feb 16 22:31:38 2016 +1100

----------------------------------------------------------------------
 .../org/apache/cayenne/query/ObjectSelect.java  | 47 +++++++++++---------
 1 file changed, 27 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cayenne/blob/faa35546/cayenne-server/src/main/java/org/apache/cayenne/query/ObjectSelect.java
----------------------------------------------------------------------
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/query/ObjectSelect.java b/cayenne-server/src/main/java/org/apache/cayenne/query/ObjectSelect.java
index f4fcb7b..a527a54 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/query/ObjectSelect.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/query/ObjectSelect.java
@@ -18,27 +18,31 @@
  ****************************************************************/
 package org.apache.cayenne.query;
 
-import java.sql.Statement;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.List;
-
-import org.apache.cayenne.CayenneRuntimeException;
-import org.apache.cayenne.DataRow;
-import org.apache.cayenne.ObjectContext;
-import org.apache.cayenne.ResultBatchIterator;
-import org.apache.cayenne.ResultIterator;
-import org.apache.cayenne.ResultIteratorCallback;
+import org.apache.cayenne.*;
 import org.apache.cayenne.exp.Expression;
 import org.apache.cayenne.exp.ExpressionFactory;
 import org.apache.cayenne.map.DbEntity;
 import org.apache.cayenne.map.EntityResolver;
 import org.apache.cayenne.map.ObjEntity;
 
+import java.sql.Statement;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
 /**
- * A selecting query providing chainable API. Can be viewed as an alternative to
- * {@link SelectQuery}.
+ * A selecting query providing chainable API. This is an alternative to
+ * {@link SelectQuery} when you want to use a fluent API. For example, the following
+ * is a convenient way to return a record:
+ * <pre>
+ * {@code
+ * Artist a = ObjectSelect
+ * .query(Artist.class)
+ * .where(Artist.NAME.eq("Picasso"))
+ * .selectOne(context);
+ * }
+ * </pre>
  * 
  * @since 4.0
  */
@@ -329,9 +333,10 @@ public class ObjectSelect<T> extends IndirectQuery implements Select<T>
{
 	}
 
 	/**
-	 * Initializes ordering clause of this query with a single ascending
-	 * ordering on a given property.
+	 * Add an ascending ordering on the given property. If there is already an ordering
+	 * on this query then add this ordering with a lower priority.
 	 * 
+	 * @param property the property to sort on
 	 * @return this object
 	 */
 	public ObjectSelect<T> orderBy(String property) {
@@ -339,9 +344,11 @@ public class ObjectSelect<T> extends IndirectQuery implements Select<T>
{
 	}
 
 	/**
-	 * Initializes ordering clause of this query with a single ordering on a
-	 * given property.
+	 * Add an ordering on the given property. If there is already an ordering
+	 * on this query then add this ordering with a lower priority.
 	 * 
+	 * @param property the property to sort on
+	 * @param sortOrder the direction of the ordering
 	 * @return this object
 	 */
 	public ObjectSelect<T> orderBy(String property, SortOrder sortOrder) {
@@ -349,7 +356,7 @@ public class ObjectSelect<T> extends IndirectQuery implements Select<T>
{
 	}
 
 	/**
-	 * Adds a list of orderings of this query.
+	 * Add one or more orderings to this query.
 	 * 
 	 * @return this object
 	 */
@@ -371,7 +378,7 @@ public class ObjectSelect<T> extends IndirectQuery implements Select<T>
{
 	}
 
 	/**
-	 * Adds a list of orderings of this query.
+	 * Adds a list of orderings to this query.
 	 * 
 	 * @return this object
 	 */


Mime
View raw message