Skip to content

Commit ea2fb62

Browse files
committed
Clarify structure of prefixes
Closes gh-14258
1 parent 6d637bc commit ea2fb62

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@
105105

106106
/**
107107
* A prefix that should be applied to each property. The prefix automatically ends
108-
* with a dot if not specified.
108+
* with a dot if not specified. A valid prefix is defined by one or more words
109+
* separated with dots (e.g. {@code "acme.system.feature"}).
109110
* @return the prefix
110111
*/
111112
String prefix() default "";

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationProperties.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2017 the original author or authors.
2+
* Copyright 2012-2018 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -43,15 +43,17 @@
4343

4444
/**
4545
* The name prefix of the properties that are valid to bind to this object. Synonym
46-
* for {@link #prefix()}.
46+
* for {@link #prefix()}. A valid prefix is defined by one or more words separated
47+
* with dots (e.g. {@code "acme.system.feature"}).
4748
* @return the name prefix of the properties to bind
4849
*/
4950
@AliasFor("prefix")
5051
String value() default "";
5152

5253
/**
5354
* The name prefix of the properties that are valid to bind to this object. Synonym
54-
* for {@link #value()}.
55+
* for {@link #value()}. A valid prefix is defined by one or more words separated with
56+
* dots (e.g. {@code "acme.system.feature"}).
5557
* @return the name prefix of the properties to bind
5658
*/
5759
@AliasFor("value")

0 commit comments

Comments
 (0)