baltzo_errorcode.h

Go to the documentation of this file.

/// @file baltzo_errorcode.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// baltzo_errorcode.h                                                 -*-C++-*-
#ifndef INCLUDED_BALTZO_ERRORCODE
#define INCLUDED_BALTZO_ERRORCODE
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup baltzo_errorcode baltzo_errorcode
/// @brief  Enumerate the set of named errors for the `baltzo` package.
/// @addtogroup bal
/// @{
/// @addtogroup baltzo
/// @{
/// @addtogroup baltzo_errorcode
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#baltzo_errorcode-purpose"> Purpose</a>
/// * <a href="#baltzo_errorcode-classes"> Classes </a>
/// * <a href="#baltzo_errorcode-description"> Description </a>
///   * <a href="#baltzo_errorcode-enumerators"> Enumerators </a>
///   * <a href="#baltzo_errorcode-usage"> Usage </a>
///     * <a href="#baltzo_errorcode-example-1-basic-syntax"> Example 1: Basic Syntax </a>
///
/// # Purpose {#baltzo_errorcode-purpose}
/// Enumerate the set of named errors for the `baltzo` package.
///
/// # Classes {#baltzo_errorcode-classes}
///
/// -  baltzo::ErrorCode: namespace for error status `enum`
///
/// @see  baltzo_localtimedescriptor, baltzo_timezoneutil
///
/// # Description {#baltzo_errorcode-description}
/// This component provides a namespace, `baltzo::ErrorCode`, for
/// the `enum` type `baltzo::ErrorCode::Enum`, which enumerates the set of named
/// error codes returned by functions across the `baltzo` package.
///
/// ## Enumerators {#baltzo_errorcode-enumerators}
///
///
/// @code
/// Name               Description
/// ----------------   --------------------------------------
/// k_UNSUPPORTED_ID   Time zone identifier is not supported.
///
/// k_OUT_OF_RANGE     A conversion would have resulted in a value outside of
///                    the valid range
/// @endcode
///
/// ## Usage {#baltzo_errorcode-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Syntax {#baltzo_errorcode-example-1-basic-syntax}
///
///
/// The following snippets of code provide a simple illustration of
/// `baltzo::ErrorCode` usage.
///
/// First, we create a variable `value` of type `baltzo::ErrorCode::Enum` and
/// initialize it with the enumerator value
/// `baltzo::ErrorCode::k_UNSUPPORTED_ID`:
/// @code
/// baltzo::ErrorCode::Enum value = baltzo::ErrorCode::k_UNSUPPORTED_ID;
/// @endcode
/// Now, we store a pointer to its ASCII representation in a variable
/// `asciiValue` of type `const char *`:
/// @code
/// const char *asciiValue = baltzo::ErrorCode::toAscii(value);
/// assert(0 == bsl::strcmp(asciiValue, "UNSUPPORTED_ID"));
/// @endcode
/// Finally, we print `value` to `bsl::cout`.
/// @code
/// bsl::cout << value << bsl::endl;
/// @endcode
/// This statement produces the following output on `stdout`:
/// @code
/// UNSUPPORTED_ID
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bal
 * @{
 */
/** @addtogroup baltzo
 * @{
 */
/** @addtogroup baltzo_errorcode
 * @{
 */
 
#include <balscm_version.h>
 
#include <bsl_iosfwd.h>
 
 
namespace baltzo {
                              // ================
                              // struct ErrorCode
                              // ================
 
/// This `struct` provides a namespace for enumerating the set of named
/// error codes that may be returned by functions in the `baltzo` package
/// that take a Zoneinfo string identifier as input.  See `Enum` in the
/// TYPES sub-section for details.
///
/// This class:
/// * supports a complete set of *enumeration* operations
///   - except for `bdex` serialization
/// * is `const` *thread-safe*
/// For terminology see @ref bsldoc_glossary .
struct ErrorCode {
 
  public:
    // TYPES
    enum Enum {
        k_UNSUPPORTED_ID = 1,     // Time zone identifier is not supported.
 
        k_OUT_OF_RANGE   = 2      // A calulation would have resulted in a
                                  // value outside of the valid range.
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
      , BAETZO_UNSUPPORTED_ID = k_UNSUPPORTED_ID
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
    };
 
  public:
    // CLASS METHODS
 
    /// Write the string representation of the specified enumeration `value`
    /// to the specified output `stream`, and return a reference to
    /// `stream`.  Optionally specify an initial indentation `level`, whose
    /// absolute value is incremented recursively for nested objects.  If
    /// `level` is specified, optionally specify `spacesPerLevel`, whose
    /// absolute value indicates the number of spaces per indentation level
    /// for this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  See `toAscii` for
    /// what constitutes the string representation of a `ErrorCode::Enum`
    /// value.
    static bsl::ostream& print(bsl::ostream&   stream,
                               ErrorCode::Enum value,
                               int             level          = 0,
                               int             spacesPerLevel = 4);
 
    /// Return the non-modifiable string representation corresponding to the
    /// specified enumeration `value`, if it exists, and a unique (error)
    /// string otherwise.  The string representation of `value` matches its
    /// corresponding enumerator name with the "k_" prefix elided.  For
    /// example:
    /// @code
    /// bsl::cout << ErrorCode::toAscii(ErrorCode::k_UNSUPPORTED_ID);
    /// @endcode
    /// will print the following on standard output:
    /// @code
    /// UNSUPPORTED_ID
    /// @endcode
    /// Note that specifying a `value` that does not match any of the
    /// enumerators will result in a string representation that is distinct
    /// from any of those corresponding to the enumerators, but is otherwise
    /// unspecified.
    static const char *toAscii(ErrorCode::Enum value);
};
 
// FREE OPERATORS
 
/// Write the string representation of the specified enumeration `value` to
/// the specified output `stream` in a single-line format, and return a
/// reference to `stream`.  See `toAscii` for what constitutes the string
/// representation of a `baltzo::ErrorCode::Enum` value.  Note that this
/// method has the same behavior as
/// @code
/// baltzo::ErrorCode::print(stream, value, 0, -1);
/// @endcode
bsl::ostream& operator<<(bsl::ostream& stream, ErrorCode::Enum value);
 
}  // close package namespace
 
// ============================================================================
//                            INLINE DEFINITIONS
// ============================================================================
 
                              // ----------------
                              // struct ErrorCode
                              // ----------------
 
// FREE OPERATORS
inline
bsl::ostream& baltzo::operator<<(bsl::ostream& stream, ErrorCode::Enum value)
{
    return ErrorCode::print(stream, value, 0, -1);
}
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2015 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */