Oracle Coherence for C++ API: coherence/lang/InterruptedException.hpp Source File

00001 /*
00002 * InterruptedException.hpp
00003 *
00004 * Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
00005 *
00006 * Oracle is a registered trademarks of Oracle Corporation and/or its
00007 * affiliates.
00008 *
00009 * This software is the confidential and proprietary information of Oracle
00010 * Corporation. You shall not disclose such confidential and proprietary
00011 * information and shall use it only in accordance with the terms of the
00012 * license agreement you entered into with Oracle.
00013 *
00014 * This notice may not be removed or altered.
00015 */
00016 #ifndef COH_INTERRUPTED_EXCEPTION_HPP
00017 #define COH_INTERRUPTED_EXCEPTION_HPP
00018 
00019 #include "coherence/lang/compatibility.hpp"
00020 
00021 #include "coherence/lang/Exception.hpp"
00022 #include "coherence/lang/String.hpp"
00023 
00024 COH_OPEN_NAMESPACE2(coherence,lang)
00025 
00026 
00027 /**
00028 * Signals that the current thread has been interrupted.
00029 */
00030 class COH_EXPORT InterruptedException
00031     : public throwable_spec<InterruptedException,
00032         extends<Exception> >
00033     {
00034     friend class factory<InterruptedException>;
00035 
00036     // ----- constructors ---------------------------------------------------
00037 
00038     protected:
00039         /**
00040         * Create an InterruptedException.
00041         *
00042         * @param vsMsg   the detail message
00043         * @param vCause  the underlying cause of the exception
00044         *
00045         * @return a new InterruptedException
00046         */
00047         InterruptedException(String::View vsMsg = String::null_string,
00048                 Exception::View vCause = NULL);
00049     };
00050 
00051 COH_CLOSE_NAMESPACE2
00052 
00053 #endif // COH_INTERRUPTED_EXCEPTION_HPP