sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/endpoint/OutgoingMessageEvent.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56 package net.jxta.endpoint;
  57
  58 /**
  59  * An event which provides notification of the the transmission status of an
  60  * outgoing message. The source of the event is the Message object.
  61  */
  62 public class OutgoingMessageEvent extends java.util.EventObject {
  63
  64     // Two low-cost msg events for reporting to selectors: success does not require an exception. An exception is too expensive
  65     // for overflow.  The message component is useless for select but we need a dummy src in order to construct an Event.  Note,
  66     // to convert OVERFLOW or SUCCESS to listener-compatible events, clone them and set the message member. Other events are
  67     // already all right.
  68     public static final OutgoingMessageEvent SUCCESS = new OutgoingMessageEvent();
  69     public static final OutgoingMessageEvent OVERFLOW = new OutgoingMessageEvent();
  70
  71     private Throwable failure = null;
  72
  73     /**
  74      * Create an Outgoing Message Event with a dummy src (message
  75      * is not specified because the event is a constant).
  76      */
  77     public OutgoingMessageEvent() {
  78         super("Unspecified");
  79     }
  80
  81     /**
  82      * Create an Outgoing Message Event.
  83      *
  84      * @param source the message for which the event is occurring.
  85      */
  86     public OutgoingMessageEvent(Message source) {
  87         super(source);
  88     }
  89
  90     /**
  91      * Create an Outgoing Message Event.
  92      *
  93      * @param source  The message for which the event is occurring.
  94      * @param failure The failure associated with this event.
  95      */
  96     public OutgoingMessageEvent(Message source, Throwable failure) {
  97         super(source);
  98         this.failure = failure;
  99     }
 100
 101     /**
 102      * Get the failure associated with this event, if any.
 103      *
 104      * @return the <code>Throwable</code> associated with the failure, if any.
 105      *         <code>null</code> if there was no associated failure.
 106      */
 107     public Throwable getFailure() {
 108         return failure;
 109     }
 110 }