View Javadoc

1   /*
2    * $Id: MessageAware.java 502296 2007-02-01 17:33:39Z niallp $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.struts2;
22  
23  /***
24   * Implemented by actions which may need to record errors or messages.
25   *
26   * <pre>
27   *   static import ResultNames.*;
28   *
29   *   public class SetName implements MessageAware {
30   *
31   *     Messages messages;
32   *     String name;
33   *
34   *     public String execute() {
35   *       return SUCCESS;
36   *     }
37   *
38   *     public void setName(String name) {
39   *       if ("".equals(name))
40   *         messages.forField("name").addError("name.required");
41   *
42   *       this.name = name;
43   *     }
44   *
45   *     public void setMessages(Messages messages) {
46   *       this.messages = messages;
47   *     }
48   *   }
49   * </pre>
50   *
51   * @author crazybob@google.com (Bob Lee)
52   */
53  public interface MessageAware {
54  
55      /***
56       * Sets messages.
57       *
58       * @param messages messages
59       */
60      void setMessages(Messages messages);
61  }