coherence/lang/NoSuchElementException.hpp

/*
* NoSuchElementException.hpp
*
* Copyright 2001-2008 by Oracle. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_NO_SUCH_ELEMENT_EXCEPTION_HPP
#define COH_NO_SUCH_ELEMENT_EXCEPTION_HPP

#include "coherence/lang/compatibility.hpp"

#include "coherence/lang/RuntimeException.hpp"
#include "coherence/lang/String.hpp"

COH_OPEN_NAMESPACE2(coherence,lang)


/**
* Thrown to indicate that a object is not found in the %cache/map/collection
*
* NoSuchElementExceptions should be caught this way:
* @code
* catch(NoSuchElementException::View nsee)
* {
* ...
* }
* @endcode
*/
class COH_EXPORT NoSuchElementException
    : public throwable_spec<NoSuchElementException,
        extends<RuntimeException, std::logic_error> >
    {
    friend class factory<NoSuchElementException>;

    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Create an NoSuchElementException.
        *
        * @param vsMsg   the detail message
        * @param vCause  the underlying cause of the exception
        */
        NoSuchElementException(String::View vsMsg = String::NULL_STRING,
                Exception::View vCause = NULL);
    };

COH_CLOSE_NAMESPACE2

#endif // COH_NO_SUCH_ELEMENT_EXCEPTION_HPP

Copyright (c) 2000-2008 Oracle. All rights reserved.