org.springframework.shell.ShellRunner Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 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;

import org.springframework.boot.ApplicationArguments;

/**
 * Interface for shell runners.
 *
 * @author Janne Valkealahti
 */
public interface ShellRunner {

	/**
	 * Checks if a particular shell runner can execute.
	 *
	 * @param args the application arguments
	 * @return true if shell runner can execute
	 */
	boolean canRun(ApplicationArguments args);

	/**
	 * Execute application.
	 *
	 * @param args the application argumets
	 * @throws Exception in errors
	 */
	void run(ApplicationArguments args) throws Exception;
}