001package org.apache.commons.jcs3.engine.control.event.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.IOException;
023
024/**
025 * Interface for an element event queue. An event queue is used to propagate
026 * ordered element events in one region.
027 */
028public interface IElementEventQueue
029{
030    /**
031     * Adds an ElementEvent to be handled
032     *
033     * @param hand
034     *            The IElementEventHandler
035     * @param event
036     *            The IElementEventHandler IElementEvent event
037     * @throws IOException
038     */
039    <T> void addElementEvent( IElementEventHandler hand, IElementEvent<T> event )
040        throws IOException;
041
042    /**
043     * Destroy the event queue
044     *
045     */
046    void dispose();
047}