Message


1   /* 
2    * Copyright 1999-2004 The Apache Software Foundation
3    * Licensed  under the  Apache License,  Version 2.0  (the "License");
4    * you may not use  this file  except in  compliance with the License.
5    * You may obtain a copy of the License at 
6    * 
7    *   http://www.apache.org/licenses/LICENSE-2.0
8    * 
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed  under the  License is distributed on an "AS IS" BASIS,
11   * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
12   * implied.
13   * 
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.excalibur.event;
18  
19  /**
20   * A Source implements the side of an event queue where queue elements are
21   * dequeued operations only.
22   *
23   * <p>
24   *   The interface design is heavily influenced by
25   *   <a HREF="mailto:mdw@cs.berkeley.edu">Matt Welsh</a>'s SandStorm server,
26   *   his demonstration of the SEDA architecture.  We have deviated where we
27   *   felt the design differences where better.
28   * </p>
29   *
30   * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
31   */
32  public interface Message
33  {
34      /**
35       * Get the attachment associated with this Message.  If there is no
36       * attachment, this method will return null.
37       *
38       * @return Object the attached Object
39       */
40      Object   getAttachment();
41  
42      /**
43       * Attach an Object to the message.
44       *
45       * @param attachment  Any arbitrary Object you wish to attach to the Message
46       */
47      void attach( Object   attachment );
48  
49      /**
50       * Clear the attachment.
51       */
52      void clear();
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags