openjpa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mik...@apache.org
Subject svn commit: r1068553 - /openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/OpenJPAEntityManager.java
Date Tue, 08 Feb 2011 20:26:37 GMT
Author: mikedd
Date: Tue Feb  8 20:26:37 2011
New Revision: 1068553

URL: http://svn.apache.org/viewvc?rev=1068553&view=rev
Log:
OPENJPA-1937: update javadoc for evict methods on OpenJPAEntityManager.

Modified:
    openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/OpenJPAEntityManager.java

Modified: openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/OpenJPAEntityManager.java
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/OpenJPAEntityManager.java?rev=1068553&r1=1068552&r2=1068553&view=diff
==============================================================================
--- openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/OpenJPAEntityManager.java
(original)
+++ openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/OpenJPAEntityManager.java
Tue Feb  8 20:26:37 2011
@@ -505,34 +505,63 @@ public interface OpenJPAEntityManager
     public void refreshAll();
 
     /**
-     * Evict the given object.
+     * <P> Evict the given object.</P>
+     * <P> Eviction acts as a hint to the persistence provider, and indicates that
the persistent object is no longer
+     * needed by the application and may be garbage collected. It does not remove the object
from the L1 cache and only
+     * affects objects which are managed and unmodified. 
+     * </P>
+     * @param pc A persistent class which will be evicted
      */
     public void evict(Object pc);
 
     /**
-     * Evict the given objects.
+     * <P>Evict the given objects.</P>
+     * <P> Eviction acts as a hint to the persistence provider, and indicates that
the persistent object is no longer
+     * needed by the application and may be garbage collected. It does not remove the object
from the L1 cache and only
+     * affects objects which are managed and unmodified. 
+     * </P>
+     * @param pcs The persistent classes which will be evicted
      */
     public void evictAll(Object... pcs);
 
     /**
-     * Evict the given objects.
+     * <P>Evict the given objects.</P>
+     * <P> Eviction acts as a hint to the persistence provider, and indicates that
the persistent object is no longer
+     * needed by the application and may be garbage collected. It does not remove the object
from the L1 cache and only
+     * affects objects which are managed and unmodified. 
+     * </P>
+     * @param pcs A collection of persistent classes which will be evicted. 
      */
     public void evictAll(Collection pcs);
 
     /**
-     * Evict all clean objects.
+     * <P>Evict all clean objects.</P>
+     * <P> Eviction acts as a hint to the persistence provider, and indicates that
the persistent object is no longer
+     * needed by the application and may be garbage collected. It does not remove the object
from the L1 cache and only
+     * affects objects which are managed and unmodified. 
+     * </P>
      */
     public void evictAll();
 
     /**
-     * Evict all persistent-clean and persistent-nontransactional
-     * instances in the extent of the given class (including subclasses).
+     * <P>Evict all persistent-clean and persistent-nontransactional
+     * instances in the extent of the given class (including subclasses).</P>
+     * <P> Eviction acts as a hint to the persistence provider, and indicates that
the persistent object is no longer
+     * needed by the application and may be garbage collected. It does not remove the object
from the L1 cache and only
+     * affects objects which are managed and unmodified. 
+     * </P>
+     * @param cls All clean instances of this class will be evicted. 
      */
     public void evictAll(Class cls);
 
     /**
-     * Evict all persistent-clean and persistent-nontransactional
-     * instances in the given {@link Extent}.
+     * <P>Evict all persistent-clean and persistent-nontransactional
+     * instances in the given {@link Extent}.</P>
+     * <P> Eviction acts as a hint to the persistence provider, and indicates that
the persistent object is no longer
+     * needed by the application and may be garbage collected. It does not remove the object
from the L1 cache and only
+     * affects objects which are managed and unmodified. 
+     * </P>
+     * @param extent Extend which contains the persistent classes to evict. 
      */
     public void evictAll(Extent extent);
 



Mime
View raw message