/*
 *
 *  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.metron.stellar.common.shell;

/**
 * Provides auto-complete functionality for Stellar.
 */
public interface StellarAutoCompleter {

  /**
   * Auto-completes based on the given buffer.
   * @param buffer The partial buffer that needs auto-completed.
   * @return Viable candidates for auto-completion.
   */
  Iterable<String> autoComplete(String buffer);

  /**
   * Adds a candidate for auto-completing function names.
   * @param name The name of the function candidate.
   */
  void addCandidateFunction(String name);

  /**
   * Adds a candidate for auto-completing variable names.
   * @param name The name of the function candidate.
   */
  void addCandidateVariable(String name);
}
