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.broadcaster.EventInfo;
    18  
    19  /**
    20   * {@code ConsumableEventInfo} allows for consuming events.
    21   *
    22   * <p>You can consume an event using the {@link #consume} method. The method
    23   * {@link #isConsumed} checks whether this event info is already consumed.
    24   * 
    25   * @author Martin Heidegger
    26   * @author Simon Wacker
    27   */
    28  interface org.as2lib.env.event.broadcaster.ConsumableEventInfo extends EventInfo {
    29  	
    30  	/**
    31  	 * Marks this event as consumed.
    32  	 */
    33  	public function consume(Void):Void;
    34  	
    35  	/**
    36  	 * Returns whether this event is consumed.
    37  	 *
    38  	 * @return {@code true} is this event is consumed else {@code false}
    39  	 */
    40  	public function isConsumed(Void):Boolean;
    41  	
    42  }