/*
* Copyright 2003 Federal Chancellery Austria
*
* 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
*
*     http://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 at.gv.egovernment.moa.util;

import java.util.Locale;

/**
 * A singleton wrapper around a <code>Message</code> object.
 * 
 * Provides the messages used in the common project.
 * 
 * @author Patrick Peck
 * @version $Id$
 */
public class MessageProvider {
  /** The location of the default message resources. */
  private static final String[] DEFAULT_MESSAGE_RESOURCES =
    { "resources/properties/common_messages" };
  /** The locale of the default message resources. */
  private static final Locale[] DEFAULT_MESSAGE_LOCALES =
    new Locale[] { new Locale("de", "AT") };
  /** The single instance of this class. */
  private static MessageProvider instance;
  
  /** The messages provided by this <code>MessageProvider</code>. */
  private Messages messages;
  
  /**
   * Return the single instance of the <code>MessageProvider</code>.
   * 
   * Intialilizes the <code>MessageProvider</code> with the default message
   * locations: <code>/resources/properties/common_messages</code>.
   * 
   * @return The single <code>MessageProvider</code>.
   */
  public static synchronized MessageProvider getInstance() {
    if (instance == null) {
      instance =
        new MessageProvider(DEFAULT_MESSAGE_RESOURCES, DEFAULT_MESSAGE_LOCALES);
    }
    return instance;
  }

  /**
   * Create a <code>MessageProvider</code>.
   * 
   * @param resourceNames The names of the resources containing the messages.
   * @param locales The corresponding locales.
   */
  protected MessageProvider(String[] resourceNames, Locale[] locales) {
    this.messages = new Messages(resourceNames, locales);
  }

  /**
   * Get the message corresponding to a given message ID.
   *
   * @param messageId The ID of the message.
   * @param parameters The parameters to fill in into the message arguments.
   * @return The formatted message. 
   */
  public String getMessage(String messageId, Object[] parameters) {
    return messages.getMessage(messageId, parameters);
  }

}