View Javadoc

1   /*
2    * Copyright 2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.scaffold.util;
18  
19  
20  /**
21   * An encapsulation of an individual message stored in a Messages object, consisting
22   * of a message key (to be used to look up message text in an appropriate
23   * message resources database) plus up to four placeholder objects that can
24   * be used for parametric replacement in the message text.
25   * @author Craig R. McClanahan
26   * @author David Winterfeldt
27   * @author Ted Husted
28   * @version $Revision: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $
29   */
30  
31  public interface Message {
32  
33      /**
34       * Get the message key for this message.
35       */
36      public String getKey();
37  
38      /**
39       * Get the replacement values for this message.
40       */
41      public Object[] getValues();
42  
43  } // end Message