|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JpaCache
Extends JPA Cache interface with additional EclipseLink API.
Method Summary | |
---|---|
void |
clear()
ADVANCED: Resets the entire Object cache, and the Query cache. |
void |
clear(java.lang.Class cls)
ADVANCED: Resets the cache for only the instances of the given Class type. |
void |
clearQueryCache()
Clear all the query caches. |
void |
clearQueryCache(java.lang.String queryName)
Clear the named query cache associated with the query name. |
boolean |
contains(java.lang.Object object)
Returns true if the cache contains an Object with the same id and Class type of the given object. |
void |
evict(java.lang.Object object)
Sets an Object to be invalid in the cache. |
java.lang.Object |
getId(java.lang.Object object)
Returns the object's Id. |
java.lang.Object |
getObject(java.lang.Class cls,
java.lang.Object id)
Returns the Object from the cache map with the id and Class type. |
boolean |
isValid(java.lang.Class cls,
java.lang.Object id)
Returns true if the Object with the id and Class type is valid in the cache. |
boolean |
isValid(java.lang.Object object)
Returns true if the Object with the same id and Class type of the the given Object is valid in the cache. |
void |
print()
Used to print all the Objects in the cache. |
void |
print(java.lang.Class cls)
Used to print all the Objects in the cache of the Class type. |
void |
printLocks()
Used to print all the currently locked cache keys in the cache. |
java.lang.Object |
putObject(java.lang.Object object)
ADVANCED: Puts the given Object into the cache. |
java.lang.Object |
removeObject(java.lang.Class cls,
java.lang.Object id)
ADVANCED: Removes the Object with the id and Class type from the cache. |
java.lang.Object |
removeObject(java.lang.Object object)
ADVANCED: Removes the Object from the cache. |
long |
timeToLive(java.lang.Object object)
Returns the remaining life of the given Object (in milliseconds). |
void |
validate()
This can be used to help debugging an Object identity problem. |
Methods inherited from interface javax.persistence.Cache |
---|
contains, evict, evict, evictAll |
Method Detail |
---|
void clear()
NOTE: Be careful using this method. This method blows away both this session's and its parent's caches. This includes the server cache or any other cache. This throws away any Objects that have been read in. Extreme caution should be used before doing this because Object identity will no longer be maintained for any Objects currently read in. This should only be called if the application knows that it no longer has references to Objects held in the cache.
void clear(java.lang.Class cls)
NOTE: Caution must be used in doing this to ensure that the Objects within the cache are not referenced from other Objects of other classes or from the application.
void clearQueryCache()
void clearQueryCache(java.lang.String queryName)
long timeToLive(java.lang.Object object)
boolean isValid(java.lang.Object object)
boolean isValid(java.lang.Class cls, java.lang.Object id)
void print()
void print(java.lang.Class cls)
void printLocks()
void validate()
java.lang.Object getObject(java.lang.Class cls, java.lang.Object id)
java.lang.Object putObject(java.lang.Object object)
java.lang.Object removeObject(java.lang.Object object)
NOTE: Caution should be used when calling to avoid violating Object identity. The application should only call this if its known that no references to the Object exist.
java.lang.Object removeObject(java.lang.Class cls, java.lang.Object id)
NOTE: Caution should be used when calling to avoid violating Object identity. The application should only call this if its known that no references to the Object exist.
boolean contains(java.lang.Object object)
void evict(java.lang.Object object)
java.lang.Object getId(java.lang.Object object)
|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |