/*
 * Copyright 2002-2019 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.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.context.support;

import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

Simple implementation of MessageSource which allows messages to be registered programmatically. This MessageSource supports basic internationalization.

Intended for testing rather than for use in production systems.

Author:Rod Johnson, Juergen Hoeller
/** * Simple implementation of {@link org.springframework.context.MessageSource} * which allows messages to be registered programmatically. * This MessageSource supports basic internationalization. * * <p>Intended for testing rather than for use in production systems. * * @author Rod Johnson * @author Juergen Hoeller */
public class StaticMessageSource extends AbstractMessageSource { private final Map<String, Map<Locale, MessageHolder>> messageMap = new HashMap<>(); @Override @Nullable protected String resolveCodeWithoutArguments(String code, Locale locale) { Map<Locale, MessageHolder> localeMap = this.messageMap.get(code); if (localeMap == null) { return null; } MessageHolder holder = localeMap.get(locale); if (holder == null) { return null; } return holder.getMessage(); } @Override @Nullable protected MessageFormat resolveCode(String code, Locale locale) { Map<Locale, MessageHolder> localeMap = this.messageMap.get(code); if (localeMap == null) { return null; } MessageHolder holder = localeMap.get(locale); if (holder == null) { return null; } return holder.getMessageFormat(); }
Associate the given message with the given code.
Params:
  • code – the lookup code
  • locale – the locale that the message should be found within
  • msg – the message associated with this lookup code
/** * Associate the given message with the given code. * @param code the lookup code * @param locale the locale that the message should be found within * @param msg the message associated with this lookup code */
public void addMessage(String code, Locale locale, String msg) { Assert.notNull(code, "Code must not be null"); Assert.notNull(locale, "Locale must not be null"); Assert.notNull(msg, "Message must not be null"); this.messageMap.computeIfAbsent(code, key -> new HashMap<>(4)).put(locale, new MessageHolder(msg, locale)); if (logger.isDebugEnabled()) { logger.debug("Added message [" + msg + "] for code [" + code + "] and Locale [" + locale + "]"); } }
Associate the given message values with the given keys as codes.
Params:
  • messages – the messages to register, with messages codes as keys and message texts as values
  • locale – the locale that the messages should be found within
/** * Associate the given message values with the given keys as codes. * @param messages the messages to register, with messages codes * as keys and message texts as values * @param locale the locale that the messages should be found within */
public void addMessages(Map<String, String> messages, Locale locale) { Assert.notNull(messages, "Messages Map must not be null"); messages.forEach((code, msg) -> addMessage(code, locale, msg)); } @Override public String toString() { return getClass().getName() + ": " + this.messageMap; } private class MessageHolder { private final String message; private final Locale locale; @Nullable private volatile MessageFormat cachedFormat; public MessageHolder(String message, Locale locale) { this.message = message; this.locale = locale; } public String getMessage() { return this.message; } public MessageFormat getMessageFormat() { MessageFormat messageFormat = this.cachedFormat; if (messageFormat == null) { messageFormat = createMessageFormat(this.message, this.locale); this.cachedFormat = messageFormat; } return messageFormat; } @Override public String toString() { return this.message; } } }