org.jboss.cache.eviction
Class EvictionPolicyConfigBase

java.lang.Object
  extended by org.jboss.cache.config.ConfigurationComponent
      extended by org.jboss.cache.eviction.EvictionPolicyConfigBase
All Implemented Interfaces:
Serializable, Cloneable, EvictionPolicyConfig
Direct Known Subclasses:
ElementSizeConfiguration, ExpirationConfiguration, FIFOConfiguration, LFUConfiguration, LRUConfiguration, MRUConfiguration

public abstract class EvictionPolicyConfigBase
extends ConfigurationComponent
implements EvictionPolicyConfig

Base implementation of EvictionPolicyConfig. Adds properties for the most commonly used config elements.

Author:
Manik Surtani
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jboss.cache.config.ConfigurationComponent
log
 
Constructor Summary
protected EvictionPolicyConfigBase()
          Can only be instantiated by a subclass.
 
Method Summary
 boolean equals(Object obj)
           
 String getEvictionPolicyClass()
          Gets the class name of the EvictionPolicy implementation this object will configure.
 int getMaxNodes()
           
 int getMinTimeToLiveSeconds()
           
 int hashCode()
           
 void reset()
          Resets the values to their defaults.
 void setEvictionPolicyClass(String evictionPolicyClass)
           
protected abstract  void setEvictionPolicyClassName()
          This method should be overridden by subclass implementers to set the default policy class name for the subclass.
 void setMaxNodes(int maxNodes)
           
 void setMinTimeToLiveSeconds(int minTimeToLiveSeconds)
           
 void validate()
          Validate the configuration.
 
Methods inherited from class org.jboss.cache.config.ConfigurationComponent
addChildConfig, addChildConfigs, clone, passCacheToChildConfig, removeChildConfig, removeChildConfigs, replaceChildConfig, replaceChildConfigs, setCache, testImmutability
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EvictionPolicyConfigBase

protected EvictionPolicyConfigBase()
Can only be instantiated by a subclass.

Calls setEvictionPolicyClassName().

Method Detail

getEvictionPolicyClass

public String getEvictionPolicyClass()
Description copied from interface: EvictionPolicyConfig
Gets the class name of the EvictionPolicy implementation this object will configure. Used by RegionManager to instantiate the policy.

Specified by:
getEvictionPolicyClass in interface EvictionPolicyConfig
Returns:
fully qualified class name

setEvictionPolicyClass

public void setEvictionPolicyClass(String evictionPolicyClass)

getMaxNodes

public int getMaxNodes()

setMaxNodes

public void setMaxNodes(int maxNodes)

getMinTimeToLiveSeconds

public int getMinTimeToLiveSeconds()

setMinTimeToLiveSeconds

public void setMinTimeToLiveSeconds(int minTimeToLiveSeconds)

validate

public void validate()
              throws ConfigurationException
Description copied from interface: EvictionPolicyConfig
Validate the configuration. Will be called after any configuration properties are set.

Specified by:
validate in interface EvictionPolicyConfig
Throws:
ConfigurationException - if any values for the configuration properties are invalid

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

reset

public void reset()
Description copied from interface: EvictionPolicyConfig
Resets the values to their defaults.

Specified by:
reset in interface EvictionPolicyConfig

setEvictionPolicyClassName

protected abstract void setEvictionPolicyClassName()
This method should be overridden by subclass implementers to set the default policy class name for the subclass. This will be called when the implementation is constructed, but is also called in reset().



Copyright © 2009 JBoss, a division of Red Hat. All Rights Reserved.