From 2b2a57b4a3ec0984a9cc319bdca48813ee6467ee Mon Sep 17 00:00:00 2001 From: Sam Brannen <104798+sbrannen@users.noreply.github.com> Date: Sat, 10 May 2025 15:44:08 +0200 Subject: [PATCH] Polish Javadoc --- .../config/PlaceholderConfigurerSupport.java | 28 +++++++++---------- .../config/PropertyOverrideConfigurer.java | 12 ++++---- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java index 108e4021faf..079543f6dc4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java @@ -37,16 +37,16 @@ import org.springframework.util.StringValueResolver; * *
* <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
- * <property name="driverClassName" value="${driver}" />
- * <property name="url" value="jdbc:${dbname}" />
+ * <property name="driverClassName" value="${jdbc.driver}" />
+ * <property name="url" value="jdbc:${jdbc.dbname}" />
* </bean>
*
*
* Example properties file:
*
* - * driver=com.mysql.jdbc.Driver - * dbname=mysql:mydb+ * jdbc.driver=com.mysql.jdbc.Driver + * jdbc.dbname=mysql:mydb * * Annotated bean definitions may take advantage of property replacement using * the {@link org.springframework.beans.factory.annotation.Value @Value} annotation: @@ -79,7 +79,7 @@ import org.springframework.util.StringValueResolver; *
Example XML property with default value: * *
- * <property name="url" value="jdbc:${dbname:defaultdb}" />
+ * <property name="url" value="jdbc:${jdbc.dbname:defaultdb}" />
*
*
* @author Chris Beams
@@ -103,6 +103,7 @@ public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfi
/** Default escape character: {@code '\'}. */
public static final Character DEFAULT_ESCAPE_CHARACTER = '\\';
+
/** Defaults to {@value #DEFAULT_PLACEHOLDER_PREFIX}. */
protected String placeholderPrefix = DEFAULT_PLACEHOLDER_PREFIX;
@@ -133,7 +134,7 @@ public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfi
/**
* Set the prefix that a placeholder string starts with.
- * The default is {@value #DEFAULT_PLACEHOLDER_PREFIX}.
+ * The default is {@value #DEFAULT_PLACEHOLDER_PREFIX}. */ public void setPlaceholderPrefix(String placeholderPrefix) { this.placeholderPrefix = placeholderPrefix; @@ -141,26 +142,25 @@ public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfi /** * Set the suffix that a placeholder string ends with. - * The default is {@value #DEFAULT_PLACEHOLDER_SUFFIX}. + *
The default is {@value #DEFAULT_PLACEHOLDER_SUFFIX}. */ public void setPlaceholderSuffix(String placeholderSuffix) { this.placeholderSuffix = placeholderSuffix; } /** - * Specify the separating character between the placeholder variable - * and the associated default value, or {@code null} if no such - * special character should be processed as a value separator. - * The default is {@value #DEFAULT_VALUE_SEPARATOR}. + * Specify the separating character between the placeholder variable and the + * associated default value, or {@code null} if no such special character + * should be processed as a value separator. + *
The default is {@value #DEFAULT_VALUE_SEPARATOR}. */ public void setValueSeparator(@Nullable String valueSeparator) { this.valueSeparator = valueSeparator; } /** - * Specify the escape character to use to ignore placeholder prefix - * or value separator, or {@code null} if no escaping should take - * place. + * Specify the escape character to use to ignore the placeholder prefix or + * value separator, or {@code null} if no escaping should take place. *
Default is {@link #DEFAULT_ESCAPE_CHARACTER}. * @since 6.2 */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java index 840a34e7623..0a26f204196 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2024 the original author or authors. + * Copyright 2002-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,12 +35,14 @@ import org.springframework.beans.factory.BeanInitializationException; * * Example properties file: * - *
dataSource.driverClassName=com.mysql.jdbc.Driver + *+ * dataSource.driverClassName=com.mysql.jdbc.Driver * dataSource.url=jdbc:mysql:mydb* - * In contrast to PropertyPlaceholderConfigurer, the original definition can have default - * values or no values at all for such bean properties. If an overriding properties file does - * not have an entry for a certain bean property, the default context definition is used. + *In contrast to {@link PropertyPlaceholderConfigurer}, the original definition + * can have default values or no values at all for such bean properties. If an + * overriding properties file does not have an entry for a certain bean property, + * the default context definition is used. * *
Note that the context definition is not aware of being overridden; * so this is not immediately obvious when looking at the XML definition file.