/* 
    P/P   *  Method: net.sourceforge.pebble.api.event.PebbleEvent__static_init
          */
     1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.api.event;
    33  
    34  import java.util.EventObject;
    35  
    36  /**
    37   * Superclass for Pebble events.
    38   *
    39   * @author Simon Brown
    40   */
    41  public abstract class PebbleEvent extends EventObject {
    42  
    43    /** the type of the event */
    44    private int type;
    45  
    46    /** flag to indicate whether this event has been vetoed */
    47    private boolean vetoed = false;
    48  
    49    /**
    50     * Creates a new instance with the specified source and type.
    51     *
    52     * @param source    the Object that created this event
    53     * @param type    the type of this event
    54     */
    55    public PebbleEvent(Object source, int type) {
             /* 
    P/P       *  Method: void net.sourceforge.pebble.api.event.PebbleEvent(Object, int)
              * 
              *  Postconditions:
              *    this.type == type
              *    init'ed(this.type)
              *    this.vetoed == 0
              */
    56      super(source);
    57  
    58      this.type = type;
    59    }
    60  
    61    /**
    62     * Gets the type of this event.
    63     *
    64     * @return  the type as an int
    65     */
    66    public int getType() {
             /* 
    P/P       *  Method: int getType()
              * 
              *  Preconditions:
              *    init'ed(this.type)
              * 
              *  Postconditions:
              *    return_value == this.type
              *    init'ed(return_value)
              */
    67      return this.type;
    68    }
    69  
    70    /**
    71     * Vetos this event so that other listeners will not reveive it.
    72     */
    73    public void veto() {
             /* 
    P/P       *  Method: void veto()
              * 
              *  Postconditions:
              *    this.vetoed == 1
              */
    74      this.vetoed = true;
    75    }
    76  
    77    /**
    78     * Determines whether this event has been vetoed.
    79     *
    80     * @return  true if this event has been vetoed, false otherwise
    81     */
    82    public boolean isVetoed() {
             /* 
    P/P       *  Method: bool isVetoed()
              * 
              *  Preconditions:
              *    init'ed(this.vetoed)
              * 
              *  Postconditions:
              *    return_value == this.vetoed
              *    init'ed(return_value)
              */
    83      return this.vetoed;
    84    }
    85  
    86    public String toString() {
             /* 
    P/P       *  Method: String toString()
              * 
              *  Preconditions:
              *    init'ed(this.source)
              *    init'ed(this.type)
              * 
              *  Presumptions:
              *    java.lang.Object:getClass(...)@87 != null
              * 
              *  Postconditions:
              *    return_value != null
              */
    87      return getClass().getName() + "/" + source + "/" + type;
    88    }
    89  
    90  }