package com.atlassian.bitbucket.mesh.app;

/**
 * Interface for exceptions that are intended to prevent the application from starting up. Implementors should
 * provide a description of the problem as the exception message, and the step(s) to take to solve the problem
 * as the {@link #getAction() action}. This will allow Spring Boot to provide a helpful error message to system
 * administrators.
 *
 * @see IllegalApplicationStateException
 */
public interface ApplicationStartupException {

    /**
     * @return the step(s) the administrator should take to solve the problem
     */
    String getAction();
}
