ICU 53.1  53.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes
icu::ErrorCode Class Reference

Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs. More...

#include <errorcode.h>

Inheritance diagram for icu::ErrorCode:
icu::UMemory

Public Member Functions

 ErrorCode ()
 Default constructor. More...
 
virtual ~ErrorCode ()
 Destructor, does nothing. More...
 
 operator UErrorCode & ()
 Conversion operator, returns a reference. More...
 
 operator UErrorCode * ()
 Conversion operator, returns a pointer. More...
 
UBool isSuccess () const
 Tests for U_SUCCESS(). More...
 
UBool isFailure () const
 Tests for U_FAILURE(). More...
 
UErrorCode get () const
 Returns the UErrorCode value. More...
 
void set (UErrorCode value)
 Sets the UErrorCode value. More...
 
UErrorCode reset ()
 Returns the UErrorCode value and resets it to U_ZERO_ERROR. More...
 
void assertSuccess () const
 Asserts isSuccess(). More...
 
const char * errorName () const
 Return a string for the UErrorCode value. More...
 

Protected Member Functions

virtual void handleFailure () const
 Called by assertSuccess() if isFailure() is true. More...
 

Protected Attributes

UErrorCode errorCode
 Internal UErrorCode, accessible to subclasses. More...
 

Detailed Description

Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs.

Intended to be used as a base class, where a subclass overrides the handleFailure() function so that it throws an exception, does an assert(), logs an error, etc. This is not an abstract base class. This class can be used and instantiated by itself, although it will be more useful when subclassed.

Features:

Note: For automatic checking for success in the destructor, a subclass must implement such logic in its own destructor because the base class destructor cannot call a subclass function (like handleFailure()). The ErrorCode base class destructor does nothing.

Note also: While it is possible for a destructor to throw an exception, it is generally unsafe to do so. This means that in a subclass the destructor and the handleFailure() function may need to take different actions.

Sample code:

class IcuErrorCode: public icu::ErrorCode {
public:
virtual ~IcuErrorCode() { // should be defined in .cpp as "key function"
// Safe because our handleFailure() does not throw exceptions.
if(isFailure()) { handleFailure(); }
}
protected:
virtual void handleFailure() const {
log_failure(u_errorName(errorCode));
exit(errorCode);
}
};
IcuErrorCode error_code;
UConverter *cnv = ucnv_open("Shift-JIS", error_code);
length = ucnv_fromUChars(dest, capacity, src, length, error_code);
// IcuErrorCode destructor checks for success.
Stable:
ICU 4.2

Definition at line 79 of file errorcode.h.

Constructor & Destructor Documentation

icu::ErrorCode::ErrorCode ( )
inline

Default constructor.

Initializes its UErrorCode to U_ZERO_ERROR.

Stable:
ICU 4.2

Definition at line 85 of file errorcode.h.

virtual icu::ErrorCode::~ErrorCode ( )
virtual

Destructor, does nothing.

See class documentation for details.

Stable:
ICU 4.2

Member Function Documentation

void icu::ErrorCode::assertSuccess ( ) const

Asserts isSuccess().

In other words, this method checks for a failure code, and the base class handles it like this:

Stable:
ICU 4.4
const char* icu::ErrorCode::errorName ( ) const

Return a string for the UErrorCode value.

The string will be the same as the name of the error code constant in the UErrorCode enum.

Stable:
ICU 4.4
UErrorCode icu::ErrorCode::get ( ) const
inline

Returns the UErrorCode value.

Stable:
ICU 4.2

Definition at line 97 of file errorcode.h.

virtual void icu::ErrorCode::handleFailure ( ) const
inlineprotectedvirtual

Called by assertSuccess() if isFailure() is true.

A subclass should override this function to deal with a failure code: Throw an exception, log an error, terminate the program, or similar.

Stable:
ICU 4.2

Definition at line 132 of file errorcode.h.

UBool icu::ErrorCode::isFailure ( ) const
inline

Tests for U_FAILURE().

Stable:
ICU 4.2

Definition at line 95 of file errorcode.h.

References U_FAILURE.

UBool icu::ErrorCode::isSuccess ( ) const
inline

Tests for U_SUCCESS().

Stable:
ICU 4.2

Definition at line 93 of file errorcode.h.

References U_SUCCESS.

icu::ErrorCode::operator UErrorCode & ( )
inline

Conversion operator, returns a reference.

Stable:
ICU 4.2

Definition at line 89 of file errorcode.h.

icu::ErrorCode::operator UErrorCode * ( )
inline

Conversion operator, returns a pointer.

Stable:
ICU 4.2

Definition at line 91 of file errorcode.h.

UErrorCode icu::ErrorCode::reset ( )

Returns the UErrorCode value and resets it to U_ZERO_ERROR.

Stable:
ICU 4.2
void icu::ErrorCode::set ( UErrorCode  value)
inline

Sets the UErrorCode value.

Stable:
ICU 4.2

Definition at line 99 of file errorcode.h.

Field Documentation

UErrorCode icu::ErrorCode::errorCode
protected

Internal UErrorCode, accessible to subclasses.

Stable:
ICU 4.2

Definition at line 125 of file errorcode.h.


The documentation for this class was generated from the following file: