org.jboss.cache.config
Interface EvictionAlgorithmConfig

All Superinterfaces:

Cloneable, CloneableConfigurationComponent, Serializable

All Known Implementing Classes:

ElementSizeAlgorithmConfig, EvictionAlgorithmConfigBase, ExpirationAlgorithmConfig, FIFOAlgorithmConfig, LFUAlgorithmConfig, LRUAlgorithmConfig, MRUAlgorithmConfig, NullEvictionAlgorithmConfig

public interface EvictionAlgorithmConfig
extends CloneableConfigurationComponent

An interface used to configure an eviction algorithm. Replaces the deprecated EvictionPolicyConfig.

In its most basic form, it is implemented by EvictionAlgorithmConfigBase, but more specific eviction policies may subclass EvictionAlgorithmConfigBase or re-implement this interface to provide access to more config variables.

Since:

3.0

Author:

Manik Surtani (manik AT jboss DOT org)

Method Summary

EvictionAlgorithmConfig	clone()
String	getEvictionAlgorithmClassName() Gets the class name of the EvictionAlgorithm implementation this object will configure.
void	reset() Resets the values to their defaults.
void	validate() Validate the configuration.

Method Detail

getEvictionAlgorithmClassName

String getEvictionAlgorithmClassName()

Gets the class name of the EvictionAlgorithm implementation this object will configure.

Returns:

fully qualified class name

validate

void validate()
              throws ConfigurationException

Validate the configuration. Will be called after any configuration properties are set.

Throws:

ConfigurationException - if any values for the configuration properties are invalid

reset

void reset()

Resets the values to their defaults.

clone

EvictionAlgorithmConfig clone()
                              throws CloneNotSupportedException

Specified by:

clone in interface CloneableConfigurationComponent

Returns:

a clone of the EvictionAlgorithmConfig.

Throws:

CloneNotSupportedException