C++ Client API Reference for Oracle Coherence: coherence/lang/IllegalArgumentException.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_ARGUMENT_EXCEPTION_HPP
00008 #define COH_ILLEGAL_ARGUMENT_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 * Thrown to indicate that a function has been passed an illegal or
00020 * inappropriate argument.
00021 */
00022 class COH_EXPORT IllegalArgumentException
00023     : public throwable_spec<IllegalArgumentException,
00024         extends<RuntimeException, std::invalid_argument> >
00025     {
00026     friend class factory<IllegalArgumentException>;
00027 
00028     // ----- constructors ---------------------------------------------------
00029 
00030     protected:
00031         /**
00032         * Create an IllegalArgumentException.
00033         *
00034         * @param vsMsg   the detail message
00035         * @param vCause  the underlying cause of the exception
00036         *
00037         * @return a new IllegalArgumentException
00038         */
00039         IllegalArgumentException(String::View vsMsg = String::null_string,
00040                 Exception::View vCause = NULL);
00041     };
00042 
00043 
00044 // ------ helper macros -----------------------------------------------------
00045 
00046 /**
00047 * Ensure the relation between two expressions.
00048 *
00049 * @param PARAM  the parameter expression
00050 * @param OP     the expected relation, i.e. ==, <, >, ...
00051 * @param VALUE  the right expression
00052 *
00053 * @throw IllegalArgumentException if an unexpected result is returned
00054 */
00055 #define COH_ENSURE_PARAM_RELATION(PARAM, OP, VALUE) \
00056     if (!(PARAM OP VALUE)) \
00057         { \
00058         COH_THROW_STREAM (coherence::lang::IllegalArgumentException, \
00059             #PARAM << " is " << PARAM << "; must be " << #OP << " " << #VALUE); \
00060         }
00061 
00062 /**
00063 * Ensure that a handle/view is not NULL.
00064 *
00065 * @param HANDLE  the handle/view to check for NULL
00066 *
00067 * @throw IllegalArgumentException if the passed in handle/view is NULL
00068 */
00069 #define COH_ENSURE_PARAM(HANDLE) COH_ENSURE_PARAM_RELATION(HANDLE, !=, NULL)
00070 
00071 COH_CLOSE_NAMESPACE2
00072 
00073 #endif // COH_ILLEGAL_ARGUMENT_EXCEPTION_HPP