api/src/main/java/brooklyn/policy/EnricherType.java

package brooklyn.policy;

import java.io.Serializable;
import java.util.Set;

import brooklyn.config.ConfigKey;

import com.google.common.annotations.Beta;

/**
 * Gives type information for an {@link Enricher}. It is immutable.
 * 
 * For enrichers that can support config keys etc being added on-the-fly,
 * then this EnricherType will be a snapshot and subsequent snapshots will
 * include the changes.
 * 
 * @since 0.6
 */
@Beta
public interface EnricherType extends Serializable {

    // TODO Consider merging this with PolicyType? Have a common super-type? It also has overlap with EntityType.
    
    /**
     * The type name of this policy (normally the fully qualified class name).
     */
    String getName();
    
    /**
     * ConfigKeys available on this policy.
     */
    Set<ConfigKey<?>> getConfigKeys();
    
    /**
     * The ConfigKey with the given name, or null if not found.
     */
    ConfigKey<?> getConfigKey(String name);
}