C++ Client API Reference for Oracle Coherence: coherence/lang/IllegalStateException.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_ILLEGAL_STATE_EXCEPTION_HPP
00008 #define COH_ILLEGAL_STATE_EXCEPTION_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/RuntimeException.hpp"
00013 #include "coherence/lang/String.hpp"
00014 
00015 COH_OPEN_NAMESPACE2(coherence,lang)
00016 
00017 
00018 /**
00019 * Signals that a function has been called at an illegal or inappropriate
00020 * time. In other words, the environment or application is not in an
00021 * appropriate state for the requested operation.
00022 */
00023 class COH_EXPORT IllegalStateException
00024     : public throwable_spec<IllegalStateException,
00025         extends<RuntimeException> >
00026     {
00027     friend class factory<IllegalStateException>;
00028 
00029     // ----- constructors ---------------------------------------------------
00030 
00031     protected:
00032         /**
00033         * Create an IllegalStateException.
00034         *
00035         * @param vsMsg   the detail message
00036         * @param vCause  the underlying cause of the exception
00037         *
00038         * @return a new IllegalStateException
00039         */
00040         IllegalStateException(String::View vsMsg = String::null_string,
00041                 Exception::View vCause = NULL);
00042     };
00043 
00044 
00045 // ----- helper macros ------------------------------------------------------
00046 
00047 /**
00048 * Ensure the relation between two expressions.
00049 *
00050 * @param TYPE  the result type of the expressions
00051 * @param EXPL  the left expression
00052 * @param OP    the expected relation, i.e. ==, <, >, ...
00053 * @param EXPR  the right expression
00054 *
00055 * @throw IllegalStateException if an unexpected result is returned
00056 */
00057 #define COH_ENSURE_RELATION(TYPE, EXPL, OP, EXPR) \
00058     { \
00059     TYPE expl = (EXPL); \
00060     TYPE expr = (EXPR); \
00061     if (!(expl OP expr)) \
00062         { \
00063         COH_THROW_STREAM (coherence::lang::IllegalStateException, \
00064             "ensuring: '" << #EXPL << ' ' << #OP << ' ' << \
00065             #EXPR << "'; result " << expl << " not " #OP << \
00066             ' ' << expr); \
00067         } \
00068     }
00069 
00070 /**
00071 * Ensure that the expression returns the expected result.
00072 *
00073 * @param EXPRESSION       the expression to evaluate, must return a result
00074 *                         which is castable to size32_t
00075 * @param EXPECTED_RESULT  the expected result, which is castable to size32_t
00076 *
00077 * @throw IllegalStateException if an unexpected result is returned
00078 */
00079 #define COH_ENSURE_EQUALITY(EXPRESSION, EXPECTED_RESULT) \
00080     COH_ENSURE_RELATION(size32_t, EXPRESSION, ==, EXPECTED_RESULT)
00081 
00082 /**
00083 * Ensure that the expression evaluates to true.
00084 *
00085 * @param EXPRESSION      the expression to evaluate, must return a result
00086 *                        which is castable to size32_t
00087 *
00088 * @throw IllegalStateException if an unexpected result is returned
00089 */
00090 #define COH_ENSURE(EXPRESSION) \
00091     COH_ENSURE_RELATION(bool, EXPRESSION, ==, true)
00092 
00093 COH_CLOSE_NAMESPACE2
00094 
00095 #endif // COH_ILLEGAL_STATE_EXCEPTION_HPP