org.springframework.shell.standard.ValueProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2022 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.shell.standard;

import java.util.List;

import org.springframework.shell.CompletionContext;
import org.springframework.shell.CompletionProposal;

/**
 * Beans implementing this interface are queried during TAB completion to gather
 * possible values of a parameter.
 *
 * @author Eric Bottard
 * @author Janne Valkealahti
 */
public interface ValueProvider {

	/**
	 * Complete completion proposals.
	 *
	 * @param completionContext the context
	 * @return the completion proposals
	 */
	List complete(CompletionContext completionContext);
}