Browse Source

Polish Javadoc

pull/35405/head
Sam Brannen 7 months ago
parent
commit
2b2a57b4a3
  1. 28
      spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java
  2. 12
      spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java

28
spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java

@ -37,16 +37,16 @@ import org.springframework.util.StringValueResolver; @@ -37,16 +37,16 @@ import org.springframework.util.StringValueResolver;
*
* <pre class="code">
* &lt;bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"&gt;
* &lt;property name="driverClassName" value="${driver}" /&gt;
* &lt;property name="url" value="jdbc:${dbname}" /&gt;
* &lt;property name="driverClassName" value="${jdbc.driver}" /&gt;
* &lt;property name="url" value="jdbc:${jdbc.dbname}" /&gt;
* &lt;/bean&gt;
* </pre>
*
* Example properties file:
*
* <pre class="code">
* driver=com.mysql.jdbc.Driver
* dbname=mysql:mydb</pre>
* jdbc.driver=com.mysql.jdbc.Driver
* jdbc.dbname=mysql:mydb</pre>
*
* 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; @@ -79,7 +79,7 @@ import org.springframework.util.StringValueResolver;
* <p>Example XML property with default value:
*
* <pre class="code">
* &lt;property name="url" value="jdbc:${dbname:defaultdb}" /&gt;
* &lt;property name="url" value="jdbc:${jdbc.dbname:defaultdb}" /&gt;
* </pre>
*
* @author Chris Beams
@ -103,6 +103,7 @@ public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfi @@ -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 @@ -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}.
* <p>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 @@ -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}.
* <p>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.
* <p>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.
* <p>Default is {@link #DEFAULT_ESCAPE_CHARACTER}.
* @since 6.2
*/

12
spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java

@ -1,5 +1,5 @@ @@ -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; @@ -35,12 +35,14 @@ import org.springframework.beans.factory.BeanInitializationException;
*
* Example properties file:
*
* <pre class="code">dataSource.driverClassName=com.mysql.jdbc.Driver
* <pre class="code">
* dataSource.driverClassName=com.mysql.jdbc.Driver
* dataSource.url=jdbc:mysql:mydb</pre>
*
* 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.
* <p>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.
*
* <p>Note that the context definition <i>is not</i> aware of being overridden;
* so this is not immediately obvious when looking at the XML definition file.

Loading…
Cancel
Save