org.ehcache.impl.config.store.heap

Class DefaultSizeOfEngineConfiguration

java.lang.Object

org.ehcache.impl.config.store.heap.DefaultSizeOfEngineConfiguration

All Implemented Interfaces:

org.ehcache.spi.service.ServiceConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineConfiguration>

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

ServiceConfiguration for the default SizeOfEngineProvider.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_MAX_OBJECT_SIZE Default maximum object size after which sizing stops
static int	DEFAULT_OBJECT_GRAPH_SIZE Default maximum object graph count after which sizing stops
static org.ehcache.config.units.MemoryUnit	DEFAULT_UNIT Default maximum object size unit after which sizing stops

Constructor Summary

Constructors

Constructor and Description
DefaultSizeOfEngineConfiguration(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
DefaultSizeOfEngineConfiguration	build(DefaultSizeOfEngineConfiguration config)
DefaultSizeOfEngineConfiguration	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.ServiceConfiguration

compatibleWith

Field Detail

DEFAULT_OBJECT_GRAPH_SIZE

public static final int DEFAULT_OBJECT_GRAPH_SIZE

Default maximum object graph count after which sizing stops

See Also:

Constant Field Values

DEFAULT_MAX_OBJECT_SIZE

public static final long DEFAULT_MAX_OBJECT_SIZE

Default maximum object size after which sizing stops

See Also:

Constant Field Values

DEFAULT_UNIT

public static final org.ehcache.config.units.MemoryUnit DEFAULT_UNIT

Default maximum object size unit after which sizing stops

Constructor Detail

DefaultSizeOfEngineConfiguration

public DefaultSizeOfEngineConfiguration(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.ServiceConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineConfiguration>

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 DefaultSizeOfEngineConfiguration derive()

Specified by:

derive in interface org.ehcache.spi.service.ServiceConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineConfiguration>

build

public DefaultSizeOfEngineConfiguration build(DefaultSizeOfEngineConfiguration config)

Specified by:

build in interface org.ehcache.spi.service.ServiceConfiguration<org.ehcache.core.spi.store.heap.SizeOfEngineProvider,DefaultSizeOfEngineConfiguration>