org.ehcache.impl.config.store.heap

Class DefaultSizeOfEngineProviderConfiguration

java.lang.Object

org.ehcache.impl.config.store.heap.DefaultSizeOfEngineProviderConfiguration

All Implemented Interfaces:

org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineProviderConfiguration>

public class DefaultSizeOfEngineProviderConfiguration
extends java.lang.Object
implements org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineProviderConfiguration>

ServiceCreationConfiguration for the default SizeOfEngineProvider.

Constructor Summary

Constructors

Constructor and Description
DefaultSizeOfEngineProviderConfiguration(long size, org.ehcache.config.units.MemoryUnit unit, long objectGraphSize) Creates a new configuration object with the provided parameters.

Method Summary

Modifier and Type	Method and Description
DefaultSizeOfEngineProviderConfiguration	build(DefaultSizeOfEngineProviderConfiguration configuration)
DefaultSizeOfEngineProviderConfiguration	derive()
long	getMaxObjectGraphSize() Returns the maximum object graph size before aborting sizing.
long	getMaxObjectSize() Returns the maximum object size before aborting sizing.
java.lang.Class<org.ehcache.core.spi.store.heap.SizeOfEngineProvider>	getServiceType()
org.ehcache.config.units.MemoryUnit	getUnit() Returns the maximum object size unit.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ehcache.spi.service.ServiceCreationConfiguration

compatibleWith

Constructor Detail

DefaultSizeOfEngineProviderConfiguration

public DefaultSizeOfEngineProviderConfiguration(long size,
                                                org.ehcache.config.units.MemoryUnit unit,
                                                long objectGraphSize)

Creates a new configuration object with the provided parameters.

Parameters:

size - the maximum object size

unit - the object size unit

objectGraphSize - the maximum object graph size

Method Detail

getServiceType

public java.lang.Class<org.ehcache.core.spi.store.heap.SizeOfEngineProvider> getServiceType()

Specified by:

getServiceType in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineProviderConfiguration>

getMaxObjectGraphSize

public long getMaxObjectGraphSize()

Returns the maximum object graph size before aborting sizing.

This measure is a count of different instances that have to be sized from the root of the graph. That is a collection with 1000 identical elements will count as two objects, while a collection with 1000 different elements will count as 1001 objects.

Returns:

the maximum graph size

getMaxObjectSize

public long getMaxObjectSize()

Returns the maximum object size before aborting sizing.

This value applies to the sum of the size of objects composing the graph being sized.

Returns:

the maximum object size

See Also:

getUnit()

getUnit

public org.ehcache.config.units.MemoryUnit getUnit()

Returns the maximum object size unit.

Returns:

the maximum object size unit

See Also:

getMaxObjectSize()

derive

public DefaultSizeOfEngineProviderConfiguration derive()

Specified by:

derive in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineProviderConfiguration>

build

public DefaultSizeOfEngineProviderConfiguration build(DefaultSizeOfEngineProviderConfiguration configuration)

Specified by:

build in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineProviderConfiguration>