/*

  * $Id: Message.java 366395 2006-01-06 02:42:19Z niallp $

  * $Revision: 366395 $

  * $Date: 2006-01-06 02:42:19 +0000 (Fri, 06 Jan 2006) $

  *

  * ====================================================================

  *

  *  Copyright 2003-2006 The Apache Software Foundation

  *

  *  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 org.apache.commons.resources;

 /**

  * An encapsulation of an individual message stored in a MessageList object, consisting

  * of a message key (to be used to look up message text in an appropriate

  * message resources database) plus up to four placeholder objects that can

  * be used for parametric replacement in the message text.

  * <p>

  * Orginally based on org.apache.struts.action.ActionMessage, Revision 50677.

  */

 public interface Message {

     /**

      * <p>Return the logical name of the {@link org.apache.commons.resources.Resources} 

      * instance this message is associated with.</p>

      *

      * @return The name of the resources instance.

      */

     public String getResourcesName();

     /**

      * @return Get the message key for this message.

      */

     public String getKey();

     /**

      * @return Get the replacement values for this message.

      */

     public Object[] getValues();

 }