001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.event;
018
019/**
020 * An event
021 * 
022 * @author Igor Vaynberg (ivaynberg)
023 * @param <T>
024 *            type of event payload
025 */
026public interface IEvent<T>
027{
028        /**
029         * Stops any further broadcast of this event
030         */
031        void stop();
032
033        /**
034         * @return true iff event has been stopped.
035         */
036        boolean isStop();
037
038        /**
039         * Stops the broadcast of this event any deeper into the hierarchy of the current sink
040         */
041        void dontBroadcastDeeper();
042
043        /**
044         * @return type of broadcast that should be used to pass this event on
045         */
046        Broadcast getType();
047
048        /**
049         * @return the source of event
050         */
051        IEventSource getSource();
052
053        /**
054         * @return payload
055         */
056        T getPayload();
057}