org.cache2k

Class StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>

java.lang.Object

org.cache2k.BaseAnyBuilder<K,T,StorageConfiguration>

org.cache2k.StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>

All Implemented Interfaces:

AnyBuilder<K,T,StorageConfiguration>

Enclosing class:

StorageConfiguration<EX>

public static class StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>
extends BaseAnyBuilder<K,T,StorageConfiguration>

Field Summary

Fields inherited from class org.cache2k.BaseAnyBuilder

root

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	bytesCapacity(int v)
StorageConfiguration	createConfiguration() Create the configuration of this submodule (not the complete configuration).
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	entryCapacity(int v)
OPT_EXTRA_CONFIG	extra()
<EXTRA_CONFIG_BUILDER extends AnyBuilder<K,T,?>> EXTRA_CONFIG_BUILDER	extra(Class<? extends StorageImplementation<EXTRA_CONFIG_BUILDER>> c)
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	flushOnClose(boolean f) Flush contents on close.
<EXTRA_CONFIG_BUILDER extends AnyBuilder<K,T,?>> StorageConfiguration.Builder<K,T,EXTRA_CONFIG_BUILDER>	implementation(Class<? extends StorageImplementation<EXTRA_CONFIG_BUILDER>> c)
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	location(String s)
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	passivation(boolean f) Only store entries in the storage that don't live in the memory any more.
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	purgeOnStartup(boolean f)
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	readOnly(boolean f) Switch storage to read only mode, e.g.
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	reliable(boolean f) False means single storage errors may be ignored.
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	storageName(String s)
StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG>	syncInterval(int v, TimeUnit u)

Methods inherited from class org.cache2k.BaseAnyBuilder

build, persistence, root

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

passivation

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> passivation(boolean f)

Only store entries in the storage that don't live in the memory any more. E.g. when an entry gets evicted it is stored.

reliable

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> reliable(boolean f)

False means single storage errors may be ignored. True will propagate errors and flush the contents on shutdown.

purgeOnStartup

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> purgeOnStartup(boolean f)

flushOnClose

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> flushOnClose(boolean f)

Flush contents on close. The default is off.

All defaults will be towards a "cache alike" behavior, not a reliable storage behavior.

readOnly

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> readOnly(boolean f)

Switch storage to read only mode, e.g. to examine the contents. This parameter is not supported by all storage implementations.

location

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> location(String s)

entryCapacity

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> entryCapacity(int v)

bytesCapacity

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> bytesCapacity(int v)

syncInterval

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> syncInterval(int v,
                                                                       TimeUnit u)

storageName

public StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> storageName(String s)

implementation

public <EXTRA_CONFIG_BUILDER extends AnyBuilder<K,T,?>> StorageConfiguration.Builder<K,T,EXTRA_CONFIG_BUILDER> implementation(Class<? extends StorageImplementation<EXTRA_CONFIG_BUILDER>> c)

extra

public <EXTRA_CONFIG_BUILDER extends AnyBuilder<K,T,?>> EXTRA_CONFIG_BUILDER extra(Class<? extends StorageImplementation<EXTRA_CONFIG_BUILDER>> c)

extra

public OPT_EXTRA_CONFIG extra()

createConfiguration

public StorageConfiguration createConfiguration()

Description copied from interface: AnyBuilder

Create the configuration of this submodule (not the complete configuration).