com.hazelcast.config

Class EvictionConfig

java.lang.Object

com.hazelcast.config.EvictionConfig

All Implemented Interfaces:

com.hazelcast.internal.eviction.EvictionConfiguration, DataSerializable, IdentifiedDataSerializable, Serializable

public class EvictionConfig
extends Object
implements com.hazelcast.internal.eviction.EvictionConfiguration, IdentifiedDataSerializable, Serializable

Configuration for eviction.

You can set a limit for number of entries or total memory cost of entries.

The default values of the eviction configuration are:

• EvictionPolicy.LRU as eviction policy
• MaxSizePolicy.ENTRY_COUNT as max size policy
• as maximum size for on-heap IMap
• 10000 as maximum size for all other data structures and configurations

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected EvictionPolicyComparator	comparator
protected String	comparatorClassName
static EvictionPolicy	DEFAULT_EVICTION_POLICY Default Eviction Policy.
static int	DEFAULT_MAX_ENTRY_COUNT Default maximum entry count.
static MaxSizePolicy	DEFAULT_MAX_SIZE_POLICY Default Max-Size Policy.
protected EvictionPolicy	evictionPolicy
protected MaxSizePolicy	maxSizePolicy
protected int	size

Constructor Summary

Constructors

Constructor and Description
EvictionConfig()
EvictionConfig(EvictionConfig config)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getClassId() Returns type identifier for this class.
EvictionPolicyComparator	getComparator() Returns the instance of the configured EvictionPolicyComparator implementation.
String	getComparatorClassName() Returns the class name of the configured EvictionPolicyComparator implementation.
EvictionPolicy	getEvictionPolicy() Returns the EvictionPolicy of this eviction configuration.
com.hazelcast.internal.eviction.EvictionStrategyType	getEvictionStrategyType() Returns the EvictionStrategyType of this eviction configuration.
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
MaxSizePolicy	getMaxSizePolicy() Returns the MaxSizePolicy of this eviction configuration.
int	getSize() Returns the size which is used by the MaxSizePolicy.
int	hashCode()
void	readData(ObjectDataInput in) Reads fields from the input stream
EvictionConfig	setComparator(EvictionPolicyComparator comparator) Sets the instance of the configured EvictionPolicyComparator implementation.
EvictionConfig	setComparatorClassName(String comparatorClassName) Sets the class name of the configured EvictionPolicyComparator implementation.
EvictionConfig	setEvictionPolicy(EvictionPolicy evictionPolicy) Sets the EvictionPolicy of this eviction configuration.
EvictionConfig	setMaxSizePolicy(MaxSizePolicy maxSizePolicy) Sets the MaxSizePolicy of this eviction configuration.
EvictionConfig	setSize(int size) Sets the size which is used by the MaxSizePolicy.
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MAX_ENTRY_COUNT

public static final int DEFAULT_MAX_ENTRY_COUNT

Default maximum entry count.

See Also:

Constant Field Values

DEFAULT_MAX_SIZE_POLICY

public static final MaxSizePolicy DEFAULT_MAX_SIZE_POLICY

Default Max-Size Policy.

DEFAULT_EVICTION_POLICY

public static final EvictionPolicy DEFAULT_EVICTION_POLICY

Default Eviction Policy.

size

protected int size

maxSizePolicy

protected MaxSizePolicy maxSizePolicy

evictionPolicy

protected EvictionPolicy evictionPolicy

comparatorClassName

protected String comparatorClassName

comparator

protected EvictionPolicyComparator comparator

Constructor Detail

EvictionConfig

public EvictionConfig()

EvictionConfig

public EvictionConfig(EvictionConfig config)

Method Detail

getSize

public int getSize()

Returns the size which is used by the MaxSizePolicy.

The interpretation of the value depends on the configured MaxSizePolicy.

Returns:

the size which is used by the MaxSizePolicy

setSize

public EvictionConfig setSize(int size)

Sets the size which is used by the MaxSizePolicy.

The interpretation of the value depends on the configured MaxSizePolicy.

Accepts any non-negative number. The default value is 10000.

Parameters:

size - the size which is used by the MaxSizePolicy

Returns:

this EvictionConfig instance

getMaxSizePolicy

public MaxSizePolicy getMaxSizePolicy()

Returns the MaxSizePolicy of this eviction configuration.

Returns:

the MaxSizePolicy of this eviction configuration

setMaxSizePolicy

public EvictionConfig setMaxSizePolicy(MaxSizePolicy maxSizePolicy)

Sets the MaxSizePolicy of this eviction configuration.

Parameters:

maxSizePolicy - the MaxSizePolicy of this eviction configuration

Returns:

this EvictionConfig instance

getEvictionPolicy

public EvictionPolicy getEvictionPolicy()

Returns the EvictionPolicy of this eviction configuration.

Specified by:

getEvictionPolicy in interface com.hazelcast.internal.eviction.EvictionConfiguration

Returns:

the EvictionPolicy of this eviction configuration

setEvictionPolicy

public EvictionConfig setEvictionPolicy(EvictionPolicy evictionPolicy)

Sets the EvictionPolicy of this eviction configuration.

Parameters:

evictionPolicy - the EvictionPolicy of this eviction configuration

Returns:

this EvictionConfig instance

getEvictionStrategyType

public com.hazelcast.internal.eviction.EvictionStrategyType getEvictionStrategyType()

Returns the EvictionStrategyType of this eviction configuration.

Specified by:

getEvictionStrategyType in interface com.hazelcast.internal.eviction.EvictionConfiguration

Returns:

the EvictionStrategyType of this eviction configuration

getComparatorClassName

public String getComparatorClassName()

Returns the class name of the configured EvictionPolicyComparator implementation.

Specified by:

getComparatorClassName in interface com.hazelcast.internal.eviction.EvictionConfiguration

Returns:

the class name of the configured EvictionPolicyComparator implementation

setComparatorClassName

public EvictionConfig setComparatorClassName(@Nonnull
                                             String comparatorClassName)

Sets the class name of the configured EvictionPolicyComparator implementation.

Only one of the comparator class name and comparator can be configured in the eviction configuration.

Parameters:

comparatorClassName - the class name of the configured EvictionPolicyComparator implementation

Returns:

this EvictionConfig instance

getComparator

public EvictionPolicyComparator getComparator()

Returns the instance of the configured EvictionPolicyComparator implementation.

Specified by:

getComparator in interface com.hazelcast.internal.eviction.EvictionConfiguration

Returns:

the instance of the configured EvictionPolicyComparator implementation

setComparator

public EvictionConfig setComparator(@Nonnull
                                    EvictionPolicyComparator comparator)

Sets the instance of the configured EvictionPolicyComparator implementation.

Only one of the comparator class name and comparator can be configured in the eviction configuration.

Parameters:

comparator - the instance of the configured EvictionPolicyComparator implementation

Returns:

this EvictionConfig instance

See Also:

MapEvictionPolicyComparator, CacheEvictionPolicyComparator

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object