root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify name generation responsibility for PropertySourceFactory impls 

Closes gh-24757
This commit is contained in:
Juergen Hoeller 2020-03-23 18:02:05 +01:00
parent bb1699a9d3
commit 2e23cf32ce
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spring-context/src/main/java/org/springframework/context/annotation/PropertySource.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2018 the original author or authors. * Copyright 2002-2020 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -170,8 +170,11 @@ import org.springframework.core.io.support.PropertySourceFactory;
public @interface PropertySource { public @interface PropertySource {
/** /**
* Indicate the name of this property source. If omitted, a name will * Indicate the name of this property source. If omitted, the {@link #factory()}
* be generated based on the description of the underlying resource. * will generate a name based on the underlying resource (in the case of
* {@link org.springframework.core.io.support.DefaultPropertySourceFactory}:
* derived from the resource description through a corresponding name-less
* {@link org.springframework.core.io.support.ResourcePropertySource} constructor).
* @see org.springframework.core.env.PropertySource#getName() * @see org.springframework.core.env.PropertySource#getName()
* @see org.springframework.core.io.Resource#getDescription() * @see org.springframework.core.io.Resource#getDescription()
*/ */

4
spring-core/src/main/java/org/springframework/core/io/support/PropertySourceFactory.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2016 the original author or authors. * Copyright 2002-2020 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -33,6 +33,8 @@ public interface PropertySourceFactory {
/** /**
* Create a {@link PropertySource} that wraps the given resource. * Create a {@link PropertySource} that wraps the given resource.
* @param name the name of the property source * @param name the name of the property source
* (can be {@code null} in which case the factory implementation
* will have to generate a name based on the given resource)
* @param resource the resource (potentially encoded) to wrap * @param resource the resource (potentially encoded) to wrap
* @return the new {@link PropertySource} (never {@code null}) * @return the new {@link PropertySource} (never {@code null})
* @throws IOException if resource resolution failed * @throws IOException if resource resolution failed