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

Polish Javadoc in ReloadableResourceBundleMessageSource 

See gh-30369
This commit is contained in:
Sam Brannen 2023-04-25 11:00:30 +02:00
parent 54853ee239
commit 2537c7c735
1 changed files with 31 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2022 the original author or authors. * Copyright 2002-2023 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.
@ -399,28 +399,35 @@ public class ReloadableResourceBundleMessageSource extends AbstractResourceBased
} }
/** /**
* Select a concrete existing {@link Resource} from a {@code bundleName}, potentially * Resolve the specified bundle {@code filename} into a concrete {@link Resource},
* checking multiple source (eg. file extensions). In case no suitable concrete * potentially checking multiple sources or file extensions.
* Resource exists this method returns a Resource for which {@link Resource#exists()} * <p>If no suitable concrete {@code Resource} can be resolved, this method
* returns {@code false}, which gets subsequently ignored. * returns a {@code Resource} for which {@link Resource#exists()} returns
* <p>This can be leveraged to check the last modification timestamp and to load * {@code false}, which gets subsequently ignored.
* properties from alternative sources. For example an XML blob in a database, or * <p>This can be leveraged to check the last modification timestamp or to load
* properties serialized in a custom format like JSON... * properties from alternative sources &mdash; for example, from an XML BLOB
* <p>The default implementation first checks for an existing file Resource with the * in a database, or from properties serialized using a custom format such as
* {@code .properties} extension, and otherwise returns a file Resource with the * JSON.
* {@code .xml} extension. * <p>The default implementation delegates to the configured
* <p>When overriding this method, {@link #loadProperties(Resource, String)} MUST be * {@link #setResourceLoader(ResourceLoader) ResourceLoader} to resolve
* capable of loading properties from any of the {@link Resource} this method can return. * resources, first checking for an existing {@code Resource} with a
* As a consequence, implementors are strongly encouraged to also override * {@code .properties} extension, and otherwise returning a {@code Resource}
* {@link #loadProperties(Resource, String)}. * with a {@code .xml} extension.
* <p>As an alternative, one could set the {@link #setPropertiesPersister(PropertiesPersister)} * <p>When overriding this method, {@link #loadProperties(Resource, String)}
* with an instance capable of dealing with all resources returned by this method. * <strong>must</strong> be capable of loading properties from any type of
* Please note however that the default {@code loadProperties} detects XML resource * {@code Resource} returned by this method. As a consequence, implementors
* filenames and uses {@link PropertiesPersister#loadFromXml(Properties, InputStream)}, * are strongly encouraged to also override {@code loadProperties()}.
* and the two {@link PropertiesPersister#load(Properties, InputStream) load} methods * <p>As an alternative to overriding this method, you can configure a
* otherwise. * {@link #setPropertiesPersister(PropertiesPersister) PropertiesPersister}
* that is capable of dealing with all resources returned by this method.
* Please note, however, that the default {@code loadProperties()} implementation
* uses {@link PropertiesPersister#loadFromXml(Properties, InputStream) loadFromXml}
* for XML resources and otherwise uses the two
* {@link PropertiesPersister#load(Properties, InputStream) load} methods
* for other types of resources.
* @param filename the bundle filename (basename + Locale)
* @return the {@code Resource} to use * @return the {@code Resource} to use
* @since 6.1.0 * @since 6.1
*/ */
protected Resource determineResource(String filename) { protected Resource determineResource(String filename) {
Resource propertiesResource = this.resourceLoader.getResource(filename + PROPERTIES_SUFFIX); Resource propertiesResource = this.resourceLoader.getResource(filename + PROPERTIES_SUFFIX);
@ -432,10 +439,11 @@ public class ReloadableResourceBundleMessageSource extends AbstractResourceBased
/** /**
* Refresh the PropertiesHolder for the given bundle filename. * Refresh the PropertiesHolder for the given bundle filename.
* The holder can be {@code null} if not cached before, or a timed-out cache entry * <p>The holder can be {@code null} if not cached before, or a timed-out cache entry
* (potentially getting re-validated against the current last-modified timestamp). * (potentially getting re-validated against the current last-modified timestamp).
* @param filename the bundle filename (basename + Locale) * @param filename the bundle filename (basename + Locale)
* @param propHolder the current PropertiesHolder for the bundle * @param propHolder the current PropertiesHolder for the bundle
* @see #determineResource(String)
*/ */
protected PropertiesHolder refreshProperties(String filename, @Nullable PropertiesHolder propHolder) { protected PropertiesHolder refreshProperties(String filename, @Nullable PropertiesHolder propHolder) {
long refreshTimestamp = (getCacheMillis() < 0 ? -1 : System.currentTimeMillis()); long refreshTimestamp = (getCacheMillis() < 0 ? -1 : System.currentTimeMillis());