Module io.ebean.core

Package io.ebeaninternal.server.core

Class CacheOptions

java.lang.Object

io.ebeaninternal.server.core.CacheOptions

public class CacheOptions
extends Object

Options for controlling cache behaviour for a given type.

Field Summary

Fields

Modifier and Type	Field	Description
static final CacheOptions	NO_CACHING	Instance when no caching is used.

Constructor Summary

Constructors

Constructor	Description
CacheOptions(io.ebean.annotation.Cache cache, String[] naturalKey)	Construct with cache annotation.

Method Summary

Modifier and Type	Method	Description
String[]	getNaturalKey()	Return the natural key property name.
String	getRegion()	Return the cache region name.
static CacheOptions	invalidateQueryCache(String region)
boolean	isEnableBeanCache()	Return true if bean caching is enabled.
boolean	isEnableQueryCache()	Return true if query caching is enabled.
boolean	isInvalidateQueryCache()	Return true if this is InvalidateQueryCache.
boolean	isReadOnly()	Return true if bean cache hits default to read only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_CACHING

public static final CacheOptions NO_CACHING

Instance when no caching is used.

Constructor Details

CacheOptions

public CacheOptions(io.ebean.annotation.Cache cache,
 String[] naturalKey)

Construct with cache annotation.

Method Details

invalidateQueryCache

public static CacheOptions invalidateQueryCache(String region)

getRegion

public String getRegion()

Return the cache region name.

isInvalidateQueryCache

public boolean isInvalidateQueryCache()

Return true if this is InvalidateQueryCache. A Bean that itself isn't L2 cached but invalidates query cache entries that join to it.

isEnableBeanCache

public boolean isEnableBeanCache()

Return true if bean caching is enabled.

isEnableQueryCache

public boolean isEnableQueryCache()

Return true if query caching is enabled.

isReadOnly

public boolean isReadOnly()

Return true if bean cache hits default to read only.

getNaturalKey

public String[] getNaturalKey()

Return the natural key property name.