com.hp.autonomy.frontend.configuration.Config Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of configuration-impl Show documentation

There is a newer version: 3.5.0

/*
 * Copyright 2013-2015 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.frontend.configuration;

import java.util.Map;

/**
 * A basic configuration object.
 *
 * Implementations of this class should be immutable.
 *
 * @param  The type of the config.
 */
public interface Config> {

    /**
     * Returns a representation of this config as a Map, suitable for use with a {@link ValidationService}.
     *
     * @return A map representation of this config.
     */
    Map getValidationMap();

    /**
     * Returns a representation of this config as a Map, suitable for use with a {@link ValidationService}.
     *
     * @return A map representation of the enabled components of this config.
     */
    Map getEnabledValidationMap();

    /**
     * Perform a basic validation of the internals of this Config.  This method should not rely on
     * external services.
     *
     * @throws ConfigException If validation fails.
     */
    void basicValidate() throws ConfigException;

    /**
     * Combine this Config with another of the same type and returns a new Config.
     *
     * The new config will have the same attributes as this config, with missing attributes supplied by other.
     *
     * Sub components of the Config should be merged where possible.
     *
     * @param other The configuration to merge with.
     *
     * @return A new Config which is a combination of this and other
     */
    T merge(T other);

}