getOptionsHelp() — spring-boot Function Reference

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

Function java GradlePlugin RunTasks calls 3 called by 1

Entity Profile

GradlePlugin→ RunTasks→ getOptionsHelp() — spring-boot Function Reference

Dependency Diagram

graph TD
  b1f527e4_cacd_61b3_b29c_ffa9e2c6a75a["getOptionsHelp()"]
  4e31183a_44fb_cbdb_9763_d221c584a2b3["getOptionsHelp()"]
  4e31183a_44fb_cbdb_9763_d221c584a2b3 -->|calls| b1f527e4_cacd_61b3_b29c_ffa9e2c6a75a
  4e31183a_44fb_cbdb_9763_d221c584a2b3["getOptionsHelp()"]
  b1f527e4_cacd_61b3_b29c_ffa9e2c6a75a -->|calls| 4e31183a_44fb_cbdb_9763_d221c584a2b3
  b6d37865_5032_0d6c_4308_ed886521baa8["getParser()"]
  b1f527e4_cacd_61b3_b29c_ffa9e2c6a75a -->|calls| b6d37865_5032_0d6c_4308_ed886521baa8
  94be601f_46c7_993d_1c1a_bdf1c95a3514["getOptionHelp()"]
  b1f527e4_cacd_61b3_b29c_ffa9e2c6a75a -->|calls| 94be601f_46c7_993d_1c1a_bdf1c95a3514
  style b1f527e4_cacd_61b3_b29c_ffa9e2c6a75a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/options/OptionHandler.java lines 134–147

	public Collection<OptionHelp> getOptionsHelp() {
		if (this.optionHelp == null) {
			OptionHelpFormatter formatter = new OptionHelpFormatter();
			getParser().formatHelpWith(formatter);
			try {
				getParser().printHelpOn(new ByteArrayOutputStream());
			}
			catch (Exception ex) {
				// Ignore and provide no hints
			}
			this.optionHelp = formatter.getOptionHelp();
		}
		return this.optionHelp;
	}