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

recordPropertiesWithDescriptions() — spring-boot Function Reference

Architecture documentation for the recordPropertiesWithDescriptions() function in ConfigurationMetadataAnnotationProcessorTests.java from the spring-boot codebase.

Function java GradlePlugin RunTasks calls 3

Entity Profile

Dependency Diagram

graph TD
  8f6ffda9_7bf6_60a6_f8f5_05a54eec515d["recordPropertiesWithDescriptions()"]
  4e7738f0_ea94_abd8_5384_e7be1344cace["compile()"]
  8f6ffda9_7bf6_60a6_f8f5_05a54eec515d -->|calls| 4e7738f0_ea94_abd8_5384_e7be1344cace
  a4041ee3_920f_3ffa_6d69_6e3bcd2c6cdc["withProperty()"]
  8f6ffda9_7bf6_60a6_f8f5_05a54eec515d -->|calls| a4041ee3_920f_3ffa_6d69_6e3bcd2c6cdc
  facc73e3_5f28_4513_9b1f_79367931e644["withDescription()"]
  8f6ffda9_7bf6_60a6_f8f5_05a54eec515d -->|calls| facc73e3_5f28_4513_9b1f_79367931e644
  style 8f6ffda9_7bf6_60a6_f8f5_05a54eec515d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

configuration-metadata/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java lines 601–616

	@Test
	void recordPropertiesWithDescriptions() {
		ConfigurationMetadata metadata = compile(ExampleRecord.class);
		assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-string", String.class)
			.withDescription("very long description that doesn't fit single line and is indented"));
		assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-integer", Integer.class)
			.withDescription("description with @param and @ pitfalls"));
		assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-boolean", Boolean.class)
			.withDescription("description with extra spaces"));
		assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-long", Long.class)
			.withDescription("description without space after asterisk"));
		assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-byte", Byte.class)
			.withDescription("last description in Javadoc"));
		assertThat(metadata).has(Metadata.withProperty("record.descriptions.named.record.component", String.class)
			.withDescription("description of a named component"));
	}

Domain

Subdomains

Calls

Source

Frequently Asked Questions

What does recordPropertiesWithDescriptions() do?
recordPropertiesWithDescriptions() is a function in the spring-boot codebase.
What does recordPropertiesWithDescriptions() call?
recordPropertiesWithDescriptions() calls 3 function(s): compile, withDescription, withProperty.

Analyze Your Own Codebase

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

Try Supermodel Free