CompletionRecoveryStrategy.java

/*
 * Copyright 2013 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
 *
 *      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.springframework.xd.dirt.stream.completion;

import java.util.List;

import org.springframework.xd.rest.domain.CompletionKind;

/**
 * Used to provide completions on ill-formed stream definitions, after an initial (failed) parse.
 * 
 * @param <E> the kind of exception that is intercepted during parsing
 * 
 * @author Eric Bottard
 */
public interface CompletionRecoveryStrategy<E extends Exception> {

	/**
	 * Whether this completion should be triggered.
	 */
	boolean shouldTrigger(String dslStart, Exception exception, CompletionKind kind);

	/**
	 * Perform code completion by adding proposals to the {@code proposals} list.
	 */
	void addProposals(String dsl, E exception, CompletionKind kind, int detailLevel, List<String> proposals);

}