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

00001 /*
00002 * IndexOutOfBoundsException.hpp
00003 *
00004 * Copyright (c) 2000, 2010, 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_INDEX_OUT_OF_BOUNDS_EXCEPTION_HPP
00017 #define COH_INDEX_OUT_OF_BOUNDS_EXCEPTION_HPP
00018 
00019 #include "coherence/lang/compatibility.hpp"
00020 
00021 #include "coherence/lang/RuntimeException.hpp"
00022 #include "coherence/lang/String.hpp"
00023 
00024 COH_OPEN_NAMESPACE2(coherence,lang)
00025 
00026 
00027 /**
00028 * Thrown to indicate that an index of some sort (such as to an array, to a
00029 * string, or to a vector) is out of range.
00030 *
00031 * @author jh  2007.12.30
00032 */
00033 class COH_EXPORT IndexOutOfBoundsException
00034     : public throwable_spec<IndexOutOfBoundsException,
00035         extends<RuntimeException, std::out_of_range> >
00036     {
00037     friend class factory<IndexOutOfBoundsException>;
00038 
00039     // ----- constructors ---------------------------------------------------
00040 
00041     protected:
00042         /**
00043         * Create an IndexOutOfBoundsException.
00044         *
00045         * @param vsMsg   the detail message
00046         * @param vCause  the underlying cause of the exception
00047         */
00048         IndexOutOfBoundsException(String::View vsMsg = String::NULL_STRING,
00049                 Exception::View vCause = NULL);
00050     };
00051 
00052 COH_CLOSE_NAMESPACE2
00053 
00054 #endif // COH_INDEX_OUT_OF_BOUNDS_EXCEPTION_HPP