bslx_testinstreamexception.h

Go to the documentation of this file.

/// @file bslx_testinstreamexception.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslx_testinstreamexception.h                                       -*-C++-*-
#ifndef INCLUDED_BSLX_TESTINSTREAMEXCEPTION
#define INCLUDED_BSLX_TESTINSTREAMEXCEPTION
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslx_testinstreamexception bslx_testinstreamexception
/// @brief  Provide an exception class for unexternalization operations.
/// @addtogroup bsl
/// @{
/// @addtogroup bslx
/// @{
/// @addtogroup bslx_testinstreamexception
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslx_testinstreamexception-purpose"> Purpose</a>
/// * <a href="#bslx_testinstreamexception-classes"> Classes </a>
/// * <a href="#bslx_testinstreamexception-description"> Description </a>
///   * <a href="#bslx_testinstreamexception-usage"> Usage </a>
///     * <a href="#bslx_testinstreamexception-example-1-throw-and-catch"> Example 1:  Throw and Catch </a>
///
/// # Purpose {#bslx_testinstreamexception-purpose}
/// Provide an exception class for unexternalization operations.
///
/// # Classes {#bslx_testinstreamexception-classes}
///
/// -  bslx::TestInStreamException: exception containing unexternalization info
///
/// @see  bslx_testinstream
///
/// # Description {#bslx_testinstreamexception-description}
/// This component defines a simple exception object for testing
/// exceptions during unexternalization operations.  The exception object
/// `bslx::TestInStreamException` contains information about an
/// unexternalization request, which can be queried by the "catcher" of the
/// exception.
///
/// ## Usage {#bslx_testinstreamexception-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1:  Throw and Catch {#bslx_testinstreamexception-example-1-throw-and-catch}
///
///
/// In the following example, the `bslx::TestInStreamException` object is
/// thrown, caught, and examined.   First, set up a `try` block and throw the
/// exception with the indication that the exception occurred during
/// unexternalization of an `unsigned int`:
/// @code
/// try {
///     throw TestInStreamException(bslx::TypeCode::e_UINT32);
/// @endcode
/// Then, catch the exception and verify the indicated cause of the exception:
/// @code
/// } catch (const bslx::TestInStreamException& e) {
///     assert(bslx::TypeCode::e_UINT32 == e.dataType());
/// }
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslx
 * @{
 */
/** @addtogroup bslx_testinstreamexception
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslx_typecode.h>
 
 
namespace bslx {
 
                        // ===========================
                        // class TestInStreamException
                        // ===========================
 
/// This class defines an exception object for unexternalization operations.
/// Instances of this class contain information about an unexternalization
/// request.
///
/// See @ref bslx_testinstreamexception 
class TestInStreamException {
 
    // DATA
    TypeCode::Enum d_dataType;  // type of the input data requested
 
  public:
    // CREATORS
 
    /// Create an exception object initialized with the specified `type`.
    explicit TestInStreamException(TypeCode::Enum type);
 
     ~TestInStreamException() = default;
        // Destroy this object.  Note that this method's definition is compiler
        // generated.
 
    // ACCESSORS
 
    /// Return the type code that was supplied at construction of this
    /// exception object.
    TypeCode::Enum dataType() const;
};
 
// ============================================================================
//                           INLINE DEFINITIONS
// ============================================================================
 
                        // ---------------------------
                        // class TestInStreamException
                        // ---------------------------
 
// CREATORS
inline
TestInStreamException::TestInStreamException(TypeCode::Enum type)
: d_dataType(type)
{
}
 
// ACCESSORS
inline
TypeCode::Enum TestInStreamException::dataType() const
{
    return d_dataType;
}
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2014 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */