001/* A class indicating that a receiver failed to contain a token to return.
002
003 Copyright (c) 1997-2014 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.actor;
029
030import ptolemy.kernel.util.KernelRuntimeException;
031import ptolemy.kernel.util.Nameable;
032
033//////////////////////////////////////////////////////////////////////////
034//// NoTokenException
035
036/**
037 This exception is thrown when an attempt is made to get a token
038 from a receiver that does not contain one.
039 To avoid this exception, code should use the hasToken() method in the
040 Receiver interface to determine if there is a token waiting.
041
042 @author Lukito Muliadi
043 @version $Id$
044 @since Ptolemy II 0.2
045 @Pt.ProposedRating Green (lmuliadi)
046 @Pt.AcceptedRating Green (neuendor)
047 @see Receiver
048 */
049@SuppressWarnings("serial")
050public class NoTokenException extends KernelRuntimeException {
051    /** Construct an exception with the given message.
052     *  @param message The message.
053     *  @deprecated Use NoTokenException(Nameable, String) so
054     *  that the UI can indicate which actor caused the error.
055     */
056    @Deprecated
057    public NoTokenException(String message) {
058        super(message);
059    }
060
061    /** Construct an exception originating from the given object,
062     *  with the given error message.
063     *  @param object The originating object.
064     *  @param message The message.
065     */
066    public NoTokenException(Nameable object, String message) {
067        super(object, message);
068    }
069
070    /** Construct an exception originating from the given object,
071     *  with the given error message.
072     *  @param object The originating object.
073     *  @param cause The cause of this exception.
074     *  @param message The message.
075     */
076    public NoTokenException(Nameable object, Throwable cause, String message) {
077        super(object, null, cause, message);
078    }
079}