org.kie.api.conf.OptionsConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2023 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.kie.api.conf;

import java.util.Collections;
import java.util.Set;

import org.kie.api.PropertiesConfiguration;

public interface OptionsConfiguration extends PropertiesConfiguration {

    void makeImmutable();

    /**
     * Gets an option value
     *
     * @param option the option class for the option being requested
     * @param 
     *
     * @return the Option value for the given option. Returns null if option is
     *         not configured.
     */
     void setOption( C option );

    /**
     * Gets an option value
     *
     * @param optionKey SingleValueOption OptionKey to look up the valye for.
     * @param  C
     *
     * @return the Option value for the given option. Returns null if option is
     *         not configured.
     */
     C getOption( OptionKey optionKey );

    /**
     * Gets an option value for the given option + key. This method should
     * be used for multi-value options, like accumulate functions configuration
     * where one option has multiple values, distinguished by a sub-key.
     *
     * @param optionKey the option class for the option being requested
     * @param subKey the key for the option being requested
     * @param  C
     *
     * @return the Option value for the given option + key. Returns null if option is
     *         not configured.
     */
    default  C getOption( OptionKey optionKey, String subKey ) {
        return null; // not all configurations have multi options,
    }

    /**
     * Deprecated, KEY now exists top level, and its preferred to be explicit that this is a sub key
     * @param optionKey
     * @return
     * @param 
     */
    @Deprecated
    default  Set getOptionKeys(OptionKey optionKey) {
        return getOptionSubKeys(optionKey);
    }

    /**
     * Retrieves the set of all sub keys for a MultiValueOption.
     *
     * @param optionKey The OptionKey for the MultiValueOption
     * @return a Set of Strings
     */
    default  Set getOptionSubKeys(OptionKey optionKey) {
        return Collections.emptySet();
    }

    ClassLoader getClassLoader();

    > X as(ConfigurationKey configuration);

}