core/camel-base/src/main/java/org/apache/camel/runtimecatalog/impl/SuggestionStrategy.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      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.apache.camel.runtimecatalog.impl;

import java.util.Set;

/**
 * Strategy to provide suggestions for unknown endpoint options
 */
public interface SuggestionStrategy {

    /**
     * Provides a list of valid option names for a did you mean function.
     *
     * @param names         valid names
     * @param unknownOption unknown option name
     * @return a list of suggested names (did you mean)
     */
    String[] suggestEndpointOptions(Set<String> names, String unknownOption);
}