001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.resources;
019    
020    /**
021     * An encapsulation of an individual message stored in a MessageList object, consisting
022     * of a message key (to be used to look up message text in an appropriate
023     * message resources database) plus up to four placeholder objects that can
024     * be used for parametric replacement in the message text.
025     * <p>
026     * Orginally based on org.apache.struts.action.ActionMessage, Revision 50677.
027     */
028    public interface Message {
029    
030        /**
031         * <p>Return the logical name of the {@link org.apache.commons.resources.Resources}
032         * instance this message is associated with.</p>
033         *
034         * @return The name of the resources instance.
035         */
036        public String getResourcesName();
037    
038        /**
039         * @return Get the message key for this message.
040         */
041        public String getKey();
042    
043        /**
044         * @return Get the replacement values for this message.
045         */
046        public Object[] getValues();
047    
048    }
049