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

getOptionsHelp() — spring-boot Function Reference

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

Function java GradlePlugin AotProcessing calls 5

Entity Profile

Dependency Diagram

graph TD
  f7741977_4ed3_06bd_b968_20c9fcfe8ad3["getOptionsHelp()"]
  6b50e343_0b59_6939_4466_a66ae8f9f1b2["getOptionsHelp()"]
  f7741977_4ed3_06bd_b968_20c9fcfe8ad3 -->|calls| 6b50e343_0b59_6939_4466_a66ae8f9f1b2
  55d8e4d5_5608_c36a_c5b1_d16bf07708b3["isHelpShown()"]
  f7741977_4ed3_06bd_b968_20c9fcfe8ad3 -->|calls| 55d8e4d5_5608_c36a_c5b1_d16bf07708b3
  8d332fdf_80bb_9ffc_2f50_7ebc81210b26["getUsageHelp()"]
  f7741977_4ed3_06bd_b968_20c9fcfe8ad3 -->|calls| 8d332fdf_80bb_9ffc_2f50_7ebc81210b26
  30e570b5_1f97_c980_dff2_aa4173c47bce["getDescription()"]
  f7741977_4ed3_06bd_b968_20c9fcfe8ad3 -->|calls| 30e570b5_1f97_c980_dff2_aa4173c47bce
  23e5bd74_cde2_fbc9_dfb8_daaa3e4110bd["getName()"]
  f7741977_4ed3_06bd_b968_20c9fcfe8ad3 -->|calls| 23e5bd74_cde2_fbc9_dfb8_daaa3e4110bd
  style f7741977_4ed3_06bd_b968_20c9fcfe8ad3 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 62–83

	@Override
	public Collection<OptionHelp> getOptionsHelp() {
		List<OptionHelp> help = new ArrayList<>();
		for (Command command : this.commandRunner) {
			if (isHelpShown(command)) {
				help.add(new OptionHelp() {

					@Override
					public Set<String> getOptions() {
						return Collections.singleton(command.getName());
					}

					@Override
					public String getUsageHelp() {
						return command.getDescription();
					}

				});
			}
		}
		return help;
	}

Domain

Subdomains

Calls

Source

Frequently Asked Questions

What does getOptionsHelp() do?
getOptionsHelp() is a function in the spring-boot codebase.
What does getOptionsHelp() call?
getOptionsHelp() calls 5 function(s): getDescription, getName, getOptionsHelp, getUsageHelp, isHelpShown.

Analyze Your Own Codebase

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

Try Supermodel Free