C++ Client API Reference for Oracle Coherence: coherence/lang/IndexOutOfBoundsException.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_INDEX_OUT_OF_BOUNDS_EXCEPTION_HPP
00008 #define COH_INDEX_OUT_OF_BOUNDS_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 an index of some sort (such as to an array, to a
00020 * string, or to a vector) is out of range.
00021 *
00022 * @author jh  2007.12.30
00023 */
00024 class COH_EXPORT IndexOutOfBoundsException
00025     : public throwable_spec<IndexOutOfBoundsException,
00026         extends<RuntimeException, std::out_of_range> >
00027     {
00028     friend class factory<IndexOutOfBoundsException>;
00029 
00030     // ----- constructors ---------------------------------------------------
00031 
00032     protected:
00033         /**
00034         * Create an IndexOutOfBoundsException.
00035         *
00036         * @param vsMsg   the detail message
00037         * @param vCause  the underlying cause of the exception
00038         */
00039         IndexOutOfBoundsException(String::View vsMsg = String::null_string,
00040                 Exception::View vCause = NULL);
00041     };
00042 
00043 COH_CLOSE_NAMESPACE2
00044 
00045 #endif // COH_INDEX_OUT_OF_BOUNDS_EXCEPTION_HPP