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