|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
EvictionPolicyConfig.java | - | - | - | - |
|
1 | /* | |
2 | * JBoss, Home of Professional Open Source | |
3 | * | |
4 | * Distributable under LGPL license. | |
5 | * See terms of license at gnu.org. | |
6 | */ | |
7 | package org.jboss.cache.config; | |
8 | ||
9 | import org.jboss.cache.eviction.EvictionPolicy; | |
10 | import org.jboss.cache.eviction.EvictionPolicyConfigBase; | |
11 | ||
12 | /** | |
13 | * This class encapsulates the configuration element for an eviction policy. | |
14 | * <p/> | |
15 | * In it's most basic form, it is implemented by {@link EvictionPolicyConfigBase}, but | |
16 | * more specific eviction policies may subclass or re-implement this interface | |
17 | * to provide access to more config variables. | |
18 | * | |
19 | * @author <a href="mailto:manik@jboss.org">Manik Surtani (manik@jboss.org)</a> | |
20 | */ | |
21 | public interface EvictionPolicyConfig | |
22 | { | |
23 | /** | |
24 | * Gets the class name of the {@link EvictionPolicy} implementation | |
25 | * this object will configure. Used by {@link org.jboss.cache.RegionManager} | |
26 | * to instantiate the policy. | |
27 | * | |
28 | * @return fully qualified class name | |
29 | */ | |
30 | String getEvictionPolicyClass(); | |
31 | ||
32 | /** | |
33 | * Validate the configuration. Will be called after any configuration | |
34 | * properties are set. | |
35 | * | |
36 | * @throws ConfigurationException if any values for the configuration | |
37 | * properties are invalid | |
38 | */ | |
39 | void validate() throws ConfigurationException; | |
40 | ||
41 | /** | |
42 | * Resets the values to their defaults. | |
43 | */ | |
44 | void reset(); | |
45 | } |
|