C++ Client API Reference for Oracle Coherence: coherence/lang/NullPointerException.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_NULL_POINTER_EXCEPTION_HPP
00008 #define COH_NULL_POINTER_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 when an application attempts to use <tt>NULL</tt> in a case where
00020 * a non-NULL handle to Object is required. These include:
00021 * <ul>
00022 * <li>Calling the instance method through a <tt>NULL</tt> handle.</li>
00023 * <li>Accessing or modifying the field through a <tt>NULL</tt> handle.</li>
00024 * <li>Dereferencing a <tt>NULL</tt> handle.</li>
00025 * </ul>
00026 * Applications should throw instances of this class to indicate other illegal
00027 * uses of <tt>NULL</tt> handles.
00028 */
00029 class COH_EXPORT NullPointerException
00030     : public throwable_spec<NullPointerException,
00031         extends<RuntimeException> >
00032     {
00033     friend class factory<NullPointerException>;
00034 
00035     // ----- constructors ---------------------------------------------------
00036 
00037     protected:
00038         /**
00039         * Create a NullPointerException.
00040         *
00041         * @param vsMsg   the detail message
00042         * @param vCause  the underlying cause of the exception
00043         */
00044         NullPointerException(String::View vsMsg = String::null_string,
00045                 Exception::View vCause = NULL);
00046     };
00047 
00048 COH_CLOSE_NAMESPACE2
00049 
00050 #endif // COH_NULL_POINTER_EXCEPTION_HPP