/*

 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.awt;

interface EventFilter {

    /**

     * Enumeration for possible values for <code>acceptEvent(AWTEvent ev)</code> method.

     * @see EventDispatchThread#pumpEventsForFilter

     */

    static enum FilterAction {

        /**

         * ACCEPT means that this filter do not filter the event and allowes other

         * active filters to proceed it. If all the active filters accept the event, it

         * is dispatched by the <code>EventDispatchThread</code>

         * @see EventDispatchThread#pumpEventsForFilter

         */

        ACCEPT,

        /**

         * REJECT means that this filter filter the event. No other filters are queried,

         * and the event is not dispatched by the <code>EventDispatchedThread</code>

         * @see EventDispatchThread#pumpEventsForFilter

         */

        REJECT,

        /**

         * ACCEPT_IMMEDIATELY means that this filter do not filter the event, no other

         * filters are queried and to proceed it, and it is dispatched by the

         * <code>EventDispatchThread</code>

         * It is not recommended to use ACCEPT_IMMEDIATELY as there may be some active

         * filters not queried yet that do not accept this event. It is primarily used

         * by modal filters.

         * @see EventDispatchThread#pumpEventsForFilter

         * @see ModalEventFilter

         */

        ACCEPT_IMMEDIATELY

    };

    FilterAction acceptEvent(AWTEvent ev);

}