Package org.springframework.shell

Interface ShellRunner

All Known Implementing Classes:
InteractiveShellRunner, NonInteractiveShellRunner, ScriptShellRunner
public interface ShellRunner
Interface for shell runners.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    canRun(org.springframework.boot.ApplicationArguments args)
    Deprecated, for removal: This API element is subject to removal in a future version.
    default boolean
    run(String[] args)
    Execute ShellRunner with given args.
    default void
    run(org.springframework.boot.ApplicationArguments args)
    Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • canRun

      @Deprecated(since="3.3.0", forRemoval=true) default boolean canRun(org.springframework.boot.ApplicationArguments args)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if a particular shell runner can execute. For canRun(ApplicationArguments) and run(ApplicationArguments) prefer run(String[]).
      Parameters:
      args - the application arguments
      Returns:
      true if shell runner can execute

    • run

      @Deprecated(since="3.3.0", forRemoval=true) default void run(org.springframework.boot.ApplicationArguments args) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Execute application. For canRun(ApplicationArguments) and run(ApplicationArguments) prefer run(String[]).
      Parameters:
      args - the application argumets
      Throws:
      Exception - in errors

    • run

      default boolean run(String[] args) throws Exception
      Execute ShellRunner with given args. Return value indicates if run operation happened and no further runners should be used.
      Parameters:
      args - the raw arguments
      Returns:
      true if run execution happened
      Throws:
      Exception - possible error during run