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.distributor.EventDistributorControl;
    18  
    19  /**
    20   * {@code ConsumableEventDistributorControl} marks the {@code EventDistributorControl}
    21   * interface as consumable.
    22   * 
    23   * <p>A distributor that implements this interface allows for consumable events.
    24   * This means that the event distribution is stopped as soon as an event is
    25   * consumed.
    26   * 
    27   * <p>An event is consumed if a listener's event method returns {@code true}. If it
    28   * returns nothing, {@code null} or {@code undefined} or {@code false} the event
    29   * will further be distributed.
    30   *
    31   * @author Simon Wacker
    32   * @author Martin Heidegger
    33   */
    34  interface org.as2lib.env.event.distributor.ConsumableEventDistributorControl extends EventDistributorControl {
    35  	
    36  }