Home / Function/ run() — spring-boot Function Reference

run() — spring-boot Function Reference

Architecture documentation for the run() function in HelpCommand.java from the spring-boot codebase.

Function java GradlePlugin RunTasks calls 10 called by 9

Entity Profile

Dependency Diagram

graph TD
  2c6b55d7_790d_f84a_3438_31a2ecf44d5d["run()"]
  bcedd85a_83c5_e4ec_0d15_900b97d6d60b["runCommand()"]
  bcedd85a_83c5_e4ec_0d15_900b97d6d60b -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  0526c2d0_2082_1f3e_dc7c_56dccd934532["missingCommand()"]
  0526c2d0_2082_1f3e_dc7c_56dccd934532 -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  a9986605_67db_d904_1b28_82268c339c5a["appArguments()"]
  a9986605_67db_d904_1b28_82268c339c5a -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  156a0dc8_4057_d8ec_220a_5b64797a9c66["handlesRegularExceptionWithMessage()"]
  156a0dc8_4057_d8ec_220a_5b64797a9c66 -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  2e506556_3514_1696_2fe3_d7f92b73de2d["handlesRegularExceptionWithoutMessage()"]
  2e506556_3514_1696_2fe3_d7f92b73de2d -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  35a7ef03_7c48_5422_b8ef_1810f0c4185c["handlesExceptionWithDashDashDebug()"]
  35a7ef03_7c48_5422_b8ef_1810f0c4185c -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  ce6a9a97_a090_3541_459b_e3e2e51f5593["help()"]
  ce6a9a97_a090_3541_459b_e3e2e51f5593 -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  e659fcfa_5e60_9e86_f685_2374b60d09e9["helpNoCommand()"]
  e659fcfa_5e60_9e86_f685_2374b60d09e9 -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  db5ec29b_5307_d4f3_b425_5e9345aabf77["helpUnknownCommand()"]
  db5ec29b_5307_d4f3_b425_5e9345aabf77 -->|calls| 2c6b55d7_790d_f84a_3438_31a2ecf44d5d
  9d0a96cd_7225_a1a4_7d58_1b34cca7b97f["run()"]
  2c6b55d7_790d_f84a_3438_31a2ecf44d5d -->|calls| 9d0a96cd_7225_a1a4_7d58_1b34cca7b97f
  e66cd798_dee1_6550_d408_1ffd83a6d5a9["NoHelpCommandArgumentsException()"]
  2c6b55d7_790d_f84a_3438_31a2ecf44d5d -->|calls| e66cd798_dee1_6550_d408_1ffd83a6d5a9
  fc88690e_99c9_f856_76c6_c71d50291cb8["info()"]
  2c6b55d7_790d_f84a_3438_31a2ecf44d5d -->|calls| fc88690e_99c9_f856_76c6_c71d50291cb8
  8d332fdf_80bb_9ffc_2f50_7ebc81210b26["getUsageHelp()"]
  2c6b55d7_790d_f84a_3438_31a2ecf44d5d -->|calls| 8d332fdf_80bb_9ffc_2f50_7ebc81210b26
  34d72f93_b1d8_9293_4ede_4cb2c2188940["getHelp()"]
  2c6b55d7_790d_f84a_3438_31a2ecf44d5d -->|calls| 34d72f93_b1d8_9293_4ede_4cb2c2188940
  style 2c6b55d7_790d_f84a_3438_31a2ecf44d5d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/core/HelpCommand.java lines 89–122

	@Override
	public ExitStatus run(String... args) throws Exception {
		if (args.length == 0) {
			throw new NoHelpCommandArgumentsException();
		}
		String commandName = args[0];
		for (Command command : this.commandRunner) {
			if (command.getName().equals(commandName)) {
				Log.info(this.commandRunner.getName() + command.getName() + " - " + command.getDescription());
				Log.info("");
				if (command.getUsageHelp() != null) {
					Log.info("usage: " + this.commandRunner.getName() + command.getName() + " "
							+ command.getUsageHelp());
					Log.info("");
				}
				if (command.getHelp() != null) {
					Log.info(command.getHelp());
				}
				Collection<HelpExample> examples = command.getExamples();
				if (examples != null) {
					Log.info((examples.size() != 1) ? "examples:" : "example:");
					Log.info("");
					for (HelpExample example : examples) {
						Log.info("    " + example.getDescription() + ":");
						Log.info("        $ " + example.getExample());
						Log.info("");
					}
					Log.info("");
				}
				return ExitStatus.OK;
			}
		}
		throw new NoSuchCommandException(commandName);
	}

Domain

Subdomains

Calls

Called By

  • appArguments()
  • handlesExceptionWithDashDashDebug()
  • handlesRegularExceptionWithMessage()
  • handlesRegularExceptionWithoutMessage()
  • help()
  • helpNoCommand()
  • helpUnknownCommand()
  • missingCommand()
  • runCommand()

Source

Frequently Asked Questions

What does run() do?
run() is a function in the spring-boot codebase.
What does run() call?
run() calls 10 function(s): NoHelpCommandArgumentsException, NoSuchCommandException, getDescription, getExample, getExamples, getHelp, getName, getUsageHelp, and 2 more.
What calls run()?
run() is called by 9 function(s): appArguments, handlesExceptionWithDashDashDebug, handlesRegularExceptionWithMessage, handlesRegularExceptionWithoutMessage, help, helpNoCommand, helpUnknownCommand, missingCommand, and 1 more.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free