View Javadoc

1   package org.apache.jcs.engine.control.event.behavior;
2   
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  
22  import java.io.IOException;
23  import java.io.Serializable;
24  
25  /**
26   * Interface for an element event queue. An event queue is used to propagate
27   * ordered element events in one region.
28   *
29   */
30  public interface IElementEventQueue extends Serializable
31  {
32  
33      /**
34       * Adds an ElementEvent to be handled
35       *
36       * @param hand
37       *            The IElementEventHandler
38       * @param event
39       *            The IElementEventHandler IElementEvent event
40       * @throws IOException
41       */
42      public void addElementEvent( IElementEventHandler hand, IElementEvent event )
43          throws IOException;
44  
45      /** Description of the Method */
46      public void destroy();
47  
48      /**
49       * Gets the alive attribute of the IElementEventQueue object
50       *
51       * @return The alive value
52       */
53      public boolean isAlive();
54  
55  }