svn commit: r433207 - /incubator/cayenne/main/trunk/core/cayenne-jdk1.4-core/src/main/java/org/apache/cayenne/query/RefreshQuery.java

[aa...@apache.org]

Author: aadamchik
Date: Mon Aug 21 02:48:09 2006
New Revision: 433207

URL: http://svn.apache.org/viewvc?rev=433207&view=rev
Log:
javadocs

Modified:
    incubator/cayenne/main/trunk/core/cayenne-jdk1.4-core/src/main/java/org/apache/cayenne/query/RefreshQuery.java

Modified: incubator/cayenne/main/trunk/core/cayenne-jdk1.4-core/src/main/java/org/apache/cayenne/query/RefreshQuery.java
URL: http://svn.apache.org/viewvc/incubator/cayenne/main/trunk/core/cayenne-jdk1.4-core/src/main/java/org/apache/cayenne/query/RefreshQuery.java?rev=433207&r1=433206&r2=433207&view=diff
==============================================================================
--- incubator/cayenne/main/trunk/core/cayenne-jdk1.4-core/src/main/java/org/apache/cayenne/query/RefreshQuery.java (original)
+++ incubator/cayenne/main/trunk/core/cayenne-jdk1.4-core/src/main/java/org/apache/cayenne/query/RefreshQuery.java Mon Aug 21 02:48:09 2006
@@ -39,26 +39,42 @@
     protected String[] groupKeys;
 
     /**
-     * A RefreshQuery that does full refresh of all registered objects.
+     * Creates a RefreshQuery that does full refresh of all registered objects, cascading
+     * refresh all the way to the shared cache.
      */
     public RefreshQuery() {
 
     }
 
+    /**
+     * Creates a RefreshQuery that refreshes a collection of objects, including
+     * invalidation of their relationships.
+     */
     public RefreshQuery(Collection objects) {
         this.objects = objects;
     }
 
+    /**
+     * Creates a RefreshQuery that refreshes a single object, including invalidation of
+     * its relationships.
+     */
     public RefreshQuery(Persistent object) {
         this(Arrays.asList(new Object[] {
             object
         }));
     }
 
+    /**
+     * Creates a RefreshQuery that refreshes results of a query and individual objects in
+     * the result.
+     */
     public RefreshQuery(Query query) {
         this.query = query;
     }
 
+    /**
+     * Creates a RefreshQuery that refreshes query results identified by group keys.
+     */
     public RefreshQuery(String[] groupKeys) {
         this.groupKeys = groupKeys;
     }