buildDescription() — spring-boot Function Reference

Architecture documentation for the buildDescription() function in InvalidConfigurationPropertyNameFailureAnalyzer.java from the spring-boot codebase.

Function java GradlePlugin DslExtensions calls 2 called by 1

Entity Profile

GradlePlugin→ DslExtensions→ buildDescription() — spring-boot Function Reference

Dependency Diagram

graph TD
  03dd220e_616f_d36c_7f8e_34178796b9ad["buildDescription()"]
  841cf232_de0d_429d_f868_f8d8561dd3f3["analyze()"]
  841cf232_de0d_429d_f868_f8d8561dd3f3 -->|calls| 03dd220e_616f_d36c_7f8e_34178796b9ad
  f2ded482_45b1_24e0_da15_7396d1863dfb["getName()"]
  03dd220e_616f_d36c_7f8e_34178796b9ad -->|calls| f2ded482_45b1_24e0_da15_7396d1863dfb
  14a9e9cb_e085_ed08_87ae_7c929c143f31["getInvalidCharacters()"]
  03dd220e_616f_d36c_7f8e_34178796b9ad -->|calls| 14a9e9cb_e085_ed08_87ae_7c929c143f31
  style 03dd220e_616f_d36c_7f8e_34178796b9ad fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

core/spring-boot/src/main/java/org/springframework/boot/diagnostics/analyzer/InvalidConfigurationPropertyNameFailureAnalyzer.java lines 45–57

	private String buildDescription(InvalidConfigurationPropertyNameException cause,
			@Nullable BeanCreationException exception) {
		StringBuilder description = new StringBuilder(
				String.format("Configuration property name '%s' is not valid:%n", cause.getName()));
		String invalid = cause.getInvalidCharacters().stream().map(this::quote).collect(Collectors.joining(", "));
		description.append(String.format("%n    Invalid characters: %s", invalid));
		if (exception != null) {
			description.append(String.format("%n    Bean: %s", exception.getBeanName()));
		}
		description.append(String.format("%n    Reason: Canonical names should be "
				+ "kebab-case ('-' separated), lowercase alpha-numeric characters and must start with a letter"));
		return description.toString();
	}