Module io.ebean.api

Package io.ebean.cache

Class ServerCacheOptions

java.lang.Object

io.ebean.cache.ServerCacheOptions

public class ServerCacheOptions
extends Object

Options for controlling a cache.

Constructor Summary

Constructors

Constructor	Description
ServerCacheOptions()	Construct with no set options.
ServerCacheOptions(boolean nearCache, io.ebean.annotation.CacheBeanTuning tuning)	Create with nearCache option.
ServerCacheOptions(io.ebean.annotation.CacheBeanTuning tuning)	Create from the cacheTuning deployment annotation.
ServerCacheOptions(io.ebean.annotation.CacheQueryTuning cacheTuning)	Create from the cacheTuning deployment annotation.

Method Summary

Modifier and Type	Method	Description
ServerCacheOptions	applyDefaults(ServerCacheOptions defaults)	Apply any settings from the default settings that have not already been specifically set.
ServerCacheOptions	copy()	Return a copy of this object.
ServerCacheOptions	copy(boolean nearCache)	Return a copy of this object with nearCache option.
int	getMaxIdleSecs()	Return the maximum idle time.
int	getMaxSecsToLive()	Return the maximum time to live.
int	getMaxSize()	Return the maximum cache size.
int	getTrimFrequency()	Return the trim frequency in seconds.
boolean	isNearCache()	Return true if nearCache was explicitly turned on.
void	setMaxIdleSecs(int maxIdleSecs)	Set the maximum idle time.
void	setMaxSecsToLive(int maxSecsToLive)	Set the maximum time to live.
void	setMaxSize(int maxSize)	Set the maximum cache size.
void	setNearCache(boolean nearCache)	Turn on nearCache option.
void	setTrimFrequency(int trimFrequency)	Set the trim frequency in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerCacheOptions

public ServerCacheOptions()

Construct with no set options.

ServerCacheOptions

public ServerCacheOptions(io.ebean.annotation.CacheBeanTuning tuning)

Create from the cacheTuning deployment annotation.

ServerCacheOptions

public ServerCacheOptions(io.ebean.annotation.CacheQueryTuning cacheTuning)

Create from the cacheTuning deployment annotation.

ServerCacheOptions

public ServerCacheOptions(boolean nearCache,
                          io.ebean.annotation.CacheBeanTuning tuning)

Create with nearCache option.

Method Detail

applyDefaults

public ServerCacheOptions applyDefaults(ServerCacheOptions defaults)

Apply any settings from the default settings that have not already been specifically set.

copy

public ServerCacheOptions copy()

Return a copy of this object.

copy

public ServerCacheOptions copy(boolean nearCache)

Return a copy of this object with nearCache option.

isNearCache

public boolean isNearCache()

Return true if nearCache was explicitly turned on.

setNearCache

public void setNearCache(boolean nearCache)

Turn on nearCache option.

getMaxSize

public int getMaxSize()

Return the maximum cache size.

setMaxSize

public void setMaxSize(int maxSize)

Set the maximum cache size.

getMaxIdleSecs

public int getMaxIdleSecs()

Return the maximum idle time.

setMaxIdleSecs

public void setMaxIdleSecs(int maxIdleSecs)

Set the maximum idle time.

getMaxSecsToLive

public int getMaxSecsToLive()

Return the maximum time to live.

setMaxSecsToLive

public void setMaxSecsToLive(int maxSecsToLive)

Set the maximum time to live.

getTrimFrequency

public int getTrimFrequency()

Return the trim frequency in seconds.

setTrimFrequency

public void setTrimFrequency(int trimFrequency)

Set the trim frequency in seconds.