ICU 4.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
errorcode.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 *
4 * Copyright (C) 2009, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 *******************************************************************************
8 * file name: errorcode.h
9 * encoding: US-ASCII
10 * tab size: 8 (not used)
11 * indentation:4
12 *
13 * created on: 2009mar10
14 * created by: Markus W. Scherer
15 */
16 
17 #ifndef __ERRORCODE_H__
18 #define __ERRORCODE_H__
19 
26 #include "unicode/utypes.h"
27 #include "unicode/uobject.h"
28 
30 
80 public:
85  ErrorCode() : errorCode(U_ZERO_ERROR) {}
87  virtual ~ErrorCode() {}
89  operator UErrorCode & () { return errorCode; }
91  operator UErrorCode * () { return &errorCode; }
93  UBool isSuccess() const { return U_SUCCESS(errorCode); }
95  UBool isFailure() const { return U_FAILURE(errorCode); }
97  UErrorCode get() const { return errorCode; }
99  void set(UErrorCode value) { errorCode=value; }
101  UErrorCode reset();
109  void check() const;
110 
111 protected:
123  virtual void handleFailure() const {}
124 };
125 
127 
128 #endif // __ERRORCODE_H__
#define U_SUCCESS(x)
Does the error code indicate success?
Definition: utypes.h:811
#define U_FAILURE(x)
Does the error code indicate a failure?
Definition: utypes.h:816
UBool isSuccess() const
Tests for U_SUCCESS().
Definition: errorcode.h:93
void set(UErrorCode value)
Sets the UErrorCode value.
Definition: errorcode.h:99
No error, no warning.
Definition: utypes.h:620
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:183
virtual void handleFailure() const
Called by check() if isFailure() is true.
Definition: errorcode.h:123
UMemory is the common ICU base class.
Definition: uobject.h:98
UBool isFailure() const
Tests for U_FAILURE().
Definition: errorcode.h:95
C++ API: Common ICU base class UObject.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API If the compiler doesn't support namespaces...
Definition: uversion.h:184
virtual ~ErrorCode()
Destructor, does nothing.
Definition: errorcode.h:87
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:593
Basic definitions for ICU, for both C and C++ APIs.
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:474
ErrorCode()
Default constructor.
Definition: errorcode.h:85
Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs...
Definition: errorcode.h:79
int8_t UBool
The ICU boolean type.
Definition: umachine.h:208
UErrorCode errorCode
Internal UErrorCode, accessible to subclasses.
Definition: errorcode.h:116