001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot;
018
019import org.springframework.core.Ordered;
020import org.springframework.core.annotation.Order;
021
022/**
023 * Interface used to indicate that a bean should <em>run</em> when it is contained within
024 * a {@link SpringApplication}. Multiple {@link ApplicationRunner} beans can be defined
025 * within the same application context and can be ordered using the {@link Ordered}
026 * interface or {@link Order @Order} annotation.
027 *
028 * @author Phillip Webb
029 * @since 1.3.0
030 * @see CommandLineRunner
031 */
032@FunctionalInterface
033public interface ApplicationRunner {
034
035        /**
036         * Callback used to run the bean.
037         * @param args incoming application arguments
038         * @throws Exception on error
039         */
040        void run(ApplicationArguments args) throws Exception;
041
042}