as2lib 0.9

     1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.env.event.multicaster.EventMulticaster;
    18  
    19  /**
    20   * {@code ConsumableEventMulticaster} multicasts an event to all added listeners
    21   * with custom arguments until the event is consumed.
    22   *
    23   * <p>A multicaster that implements this interface allows for consumable events.
    24   * This means that the event dispatch is stopped as soon as an event is consumed.
    25   * 
    26   * <p>An event is consumed if a listener's event method returns {@code true}. If it
    27   * returns nothing, {@code null} or {@code undefined} or {@code false} the event
    28   * will further be dispatched.
    29   * 
    30   * @author Simon Wacker
    31   */
    32  interface org.as2lib.env.event.multicaster.ConsumableEventMulticaster extends EventMulticaster {
    33  	
    34  }