Spring Framework 6.1.4 · org.springframework.ui.context.support.ResourceBundleThemeSource

Modifier and Type	Field and Description
private String	basenamePrefix
private ClassLoader	beanClassLoader
private String	defaultEncoding
private Boolean	fallbackToSystemLocale
protected final Log	logger
private ThemeSource	parentThemeSource References Deprecated `ThemeSource` is deprecated or references (maybe indirectly) at least one deprecated element.
private final Map<String, Theme>	themeCache Map from theme name to Theme instance.

Access	Constructor and Description
public	ResourceBundleThemeSource()

Method Summary

Modifier and Type	Method and Description
protected MessageSource	Returns: the MessageSource createMessageSource(String the basename to create a MessageSource for basename) Create a MessageSource for the given basename, to be used as MessageSource for the corresponding theme.
public ThemeSource	getParentThemeSource() Implements org.springframework.ui.context.HierarchicalThemeSource.getParentThemeSource. References Deprecated `ThemeSource` is deprecated or references (maybe indirectly) at least one deprecated element. Return the parent of this ThemeSource, or `null` if none.
public Theme	getTheme(String the name of the theme themeName) Implements org.springframework.ui.context.ThemeSource.getTheme. References Deprecated `Theme` is deprecated or references (maybe indirectly) at least one deprecated element. This implementation returns a SimpleTheme instance, holding a ResourceBundle-based MessageSource whose basename corresponds to the given theme name (prefixed by the configured "basenamePrefix").
protected void	initParent(Theme the Theme to (re-)initialize theme) References Deprecated `Theme` is deprecated or references (maybe indirectly) at least one deprecated element. Initialize the MessageSource of the given theme with the one from the corresponding parent of this ThemeSource.
public void	setBasenamePrefix(String basenamePrefix) Set the prefix that gets applied to the ResourceBundle basenames, i.e. the theme names.
public void	setBeanClassLoader(ClassLoader the owning class loader beanClassLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance.
public void	setDefaultEncoding(String defaultEncoding) Set the default charset to use for parsing resource bundle files.
public void	setFallbackToSystemLocale(boolean fallbackToSystemLocale) Set whether to fall back to the system Locale if no files for a specific Locale have been found.
public void	setParentThemeSource(ThemeSource the parent ThemeSource that will be used to resolve messages that this object can't resolve. May be `null`, in which case no further resolution is possible. parent) Implements org.springframework.ui.context.HierarchicalThemeSource.setParentThemeSource. References Deprecated `ThemeSource` is deprecated or references (maybe indirectly) at least one deprecated element. Set the parent that will be used to try to resolve theme messages that this object can't resolve.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

basenamePrefix	back to summary
private String basenamePrefix

beanClassLoader	back to summary
private ClassLoader beanClassLoader Annotations @Nullable

defaultEncoding	back to summary
private String defaultEncoding Annotations @Nullable

fallbackToSystemLocale	back to summary
private Boolean fallbackToSystemLocale Annotations @Nullable

logger	back to summary
protected final Log logger

parentThemeSource	back to summary
private ThemeSource parentThemeSource References Deprecated `ThemeSource` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Annotations @Nullable

themeCache	back to summary
private final Map<String, Theme> themeCache Map from theme name to Theme instance.

ResourceBundleThemeSource	back to summary
public ResourceBundleThemeSource()

Method Detail

createMessageSource back to summary

createMessageSource	back to summary
protected MessageSource createMessageSource(String basename) Create a MessageSource for the given basename, to be used as MessageSource for the corresponding theme. Default implementation creates a ResourceBundleMessageSource. for the given basename. A subclass could create a specifically configured ReloadableResourceBundleMessageSource, for example. Parameters basename:String the basename to create a MessageSource for Returns:MessageSource the MessageSource See Also `org.springframework.context.support.ResourceBundleMessageSource`, `org.springframework.context.support.ReloadableResourceBundleMessageSource`

protected MessageSource createMessageSource(String basename)

Create a MessageSource for the given basename, to be used as MessageSource for the corresponding theme.

Default implementation creates a ResourceBundleMessageSource. for the given basename. A subclass could create a specifically configured ReloadableResourceBundleMessageSource, for example.

Parameters

basename:String: the basename to create a MessageSource for

Returns:MessageSource

the MessageSource

getParentThemeSource back to summary

getParentThemeSource	back to summary
public ThemeSource getParentThemeSource() Implements org.springframework.ui.context.HierarchicalThemeSource.getParentThemeSource. Doc from org.springframework.ui.context.HierarchicalThemeSource.getParentThemeSource. References Deprecated `ThemeSource` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Return the parent of this ThemeSource, or `null` if none. Annotations @Override @Nullable

public ThemeSource getParentThemeSource()

Implements org.springframework.ui.context.HierarchicalThemeSource.getParentThemeSource.

Doc from org.springframework.ui.context.HierarchicalThemeSource.getParentThemeSource.

References Deprecated

ThemeSource is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Return the parent of this ThemeSource, or null if none.

Annotations

@Override
@Nullable

getTheme back to summary

getTheme	back to summary
public Theme getTheme(String themeName) Implements org.springframework.ui.context.ThemeSource.getTheme. References Deprecated `Theme` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. This implementation returns a SimpleTheme instance, holding a ResourceBundle-based MessageSource whose basename corresponds to the given theme name (prefixed by the configured "basenamePrefix"). SimpleTheme instances are cached per theme name. Use a reloadable MessageSource if themes should reflect changes to the underlying files. Parameters themeName:String Doc from org.springframework.ui.context.ThemeSource.getTheme. the name of the theme Returns:Theme Doc from org.springframework.ui.context.ThemeSource.getTheme. the corresponding Theme, or `null` if none defined. Note that, by convention, a ThemeSource should at least be able to return a default Theme for the default theme name "theme" but may also return default Themes for other theme names. Annotations @Override @Nullable See Also `setBasenamePrefix`, `createMessageSource`

public Theme getTheme(String themeName)

Implements org.springframework.ui.context.ThemeSource.getTheme.

References Deprecated

Theme is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

This implementation returns a SimpleTheme instance, holding a ResourceBundle-based MessageSource whose basename corresponds to the given theme name (prefixed by the configured "basenamePrefix").

SimpleTheme instances are cached per theme name. Use a reloadable MessageSource if themes should reflect changes to the underlying files.

Parameters

themeName:String

Doc from org.springframework.ui.context.ThemeSource.getTheme.

the name of the theme

Returns:Theme

Doc from org.springframework.ui.context.ThemeSource.getTheme.

the corresponding Theme, or null if none defined. Note that, by convention, a ThemeSource should at least be able to return a default Theme for the default theme name "theme" but may also return default Themes for other theme names.

Annotations

@Override
@Nullable

initParent back to summary

initParent	back to summary
protected void initParent(Theme theme) References Deprecated `Theme` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Initialize the MessageSource of the given theme with the one from the corresponding parent of this ThemeSource. Parameters theme:Theme the Theme to (re-)initialize

protected void initParent(Theme theme)

References Deprecated

Theme is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Initialize the MessageSource of the given theme with the one from the corresponding parent of this ThemeSource.

Parameters

theme:Theme: the Theme to (re-)initialize

setBasenamePrefix back to summary

setBasenamePrefix	back to summary
public void setBasenamePrefix(String basenamePrefix) Set the prefix that gets applied to the ResourceBundle basenames, i.e. the theme names. E.g.: basenamePrefix="test.", themeName="theme" → basename="test.theme". Note that ResourceBundle names are effectively classpath locations: As a consequence, the JDK's standard ResourceBundle treats dots as package separators. This means that "test.theme" is effectively equivalent to "test/theme", just like it is for programmatic `java.util.ResourceBundle` usage. See Also `java.util.ResourceBundle#getBundle(String)`

public void setBasenamePrefix(String basenamePrefix)

Set the prefix that gets applied to the ResourceBundle basenames, i.e. the theme names. E.g.: basenamePrefix="test.", themeName="theme" → basename="test.theme".

Note that ResourceBundle names are effectively classpath locations: As a consequence, the JDK's standard ResourceBundle treats dots as package separators. This means that "test.theme" is effectively equivalent to "test/theme", just like it is for programmatic java.util.ResourceBundle usage.

See Also: java.util.ResourceBundle#getBundle(String)

setBeanClassLoader back to summary

setBeanClassLoader	back to summary
public void setBeanClassLoader(ClassLoader beanClassLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance. Invoked after the population of normal bean properties but before an initialization callback such as `InitializingBean's` `InitializingBean#afterPropertiesSet()` method or a custom init-method. Parameters beanClassLoader:ClassLoader the owning class loader Annotations @Override

public void setBeanClassLoader(ClassLoader beanClassLoader)

Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean#afterPropertiesSet() method or a custom init-method.

Parameters

beanClassLoader:ClassLoader: the owning class loader

Annotations

@Override

setDefaultEncoding back to summary

setDefaultEncoding	back to summary
public void setDefaultEncoding(String defaultEncoding) Set the default charset to use for parsing resource bundle files. `ResourceBundleMessageSource`'s default is the `java.util.ResourceBundle` default encoding: ISO-8859-1. Since 4.2 See Also `ResourceBundleMessageSource#setDefaultEncoding`

public void setDefaultEncoding(String defaultEncoding)

Set the default charset to use for parsing resource bundle files.

ResourceBundleMessageSource's default is the java.util.ResourceBundle default encoding: ISO-8859-1.

Since: 4.2
See Also: ResourceBundleMessageSource#setDefaultEncoding

setFallbackToSystemLocale back to summary

setFallbackToSystemLocale	back to summary
public void setFallbackToSystemLocale(boolean fallbackToSystemLocale) Set whether to fall back to the system Locale if no files for a specific Locale have been found. `ResourceBundleMessageSource`'s default is "true". Since 4.2 See Also `ResourceBundleMessageSource#setFallbackToSystemLocale`

public void setFallbackToSystemLocale(boolean fallbackToSystemLocale)

Set whether to fall back to the system Locale if no files for a specific Locale have been found.

ResourceBundleMessageSource's default is "true".

Since: 4.2
See Also: ResourceBundleMessageSource#setFallbackToSystemLocale

setParentThemeSource back to summary

setParentThemeSource	back to summary
public void setParentThemeSource(ThemeSource parent) Implements org.springframework.ui.context.HierarchicalThemeSource.setParentThemeSource. Doc from org.springframework.ui.context.HierarchicalThemeSource.setParentThemeSource. References Deprecated `ThemeSource` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Set the parent that will be used to try to resolve theme messages that this object can't resolve. Parameters parent:ThemeSource the parent ThemeSource that will be used to resolve messages that this object can't resolve. May be `null`, in which case no further resolution is possible. Annotations @Override

public void setParentThemeSource(ThemeSource parent)

Implements org.springframework.ui.context.HierarchicalThemeSource.setParentThemeSource.

Doc from org.springframework.ui.context.HierarchicalThemeSource.setParentThemeSource.

References Deprecated

ThemeSource is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Set the parent that will be used to try to resolve theme messages that this object can't resolve.

Parameters

parent:ThemeSource: the parent ThemeSource that will be used to resolve messages that this object can't resolve. May be null, in which case no further resolution is possible.

Annotations

@Override

public Class ResourceBundleThemeSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail