An enhanced enumerated type used as return values throughout ULAPI to represent various error conditions. More...

#include <ulerror.h>

Public Member Functions
	ULError ()

	ULError (const ULError &other)

	ULError (int id)

	ULError (const char *otherStringID)

virtual	~ULError ()

virtual void	clear ()

ULError &	operator= (const ULError &other)

ULError &	operator= (int otherID)

ULError &	operator= (const char *otherStringID)

bool	operator== (const ULError &other) const

bool	operator== (const char *otherStringID) const

bool	operator!= (const ULError &other) const

bool	operator!= (const char *otherStringID) const

bool	operator< (const ULError &other) const

bool	operator< (const char *otherStringID) const

Public Member Functions inherited from ULEnum
	ULEnum ()

	ULEnum (const ULEnum &other)

virtual	~ULEnum ()

virtual ULEnum &	operator= (const ULEnum &other)

	operator int () const

uluint32	hash (uluint32 tableSize) const

int	getID () const

const char *	getStringID () const

virtual const char *	getDisplayString () const

Static Public Member Functions
static int	getEnumeratedValueCount ()

static const ULError &	getInstance (int id)

Static Public Member Functions inherited from ULEnum
static bool	isEnumeratedFeature (const ULString &featureName)

static uluint32	getRunTimeFeatureID (const ULString &featureName)

Static Public Attributes
static const ULError &	NoError = ULError("noerror", "No error")

static const ULError &	NotImplemented = ULError("notimplemented", "Not implemented")

static const ULError &	ObjectUninitialized = ULError("uninitialized", "Object uninitialized")

static const ULError &	MemoryAllocationFailed = ULError("memory", "Memory allocation failed")

static const ULError &	InvalidID = ULError("invalidid", "Invalid ID")

static const ULError &	InvalidName = ULError("invalidname", "Invalid name")

static const ULError &	ICUError = ULError("icu", "ICU error")

static const ULError &	DataSourceAttachFailed = ULError("datasourceattach", "Data source failed to attach")

static const ULError &	DataSourceOpenFailed = ULError("datasourceopen", "Data source failed to open")

static const ULError &	InvalidDataSourceVersion = ULError("invaliddatasourceversion", "Data source has an invalid version")

static const ULError &	InvalidLanguageFile = ULError("invalidlanguagefile", "Invalid language file")

static const ULError &	InvalidIterator = ULError("invaliditerator", "Invalid iterator")

static const ULError &	NoMatch = ULError("nomatch", "No match")

static const ULError &	TooManyMatches = ULError("toomanymatches", "Too many matches")

static const ULError &	NoSuchObject = ULError("nosuchobject", "No such object")

static const ULError &	OperationCancelled = ULError("operationcancelled", "Operation cancelled")

Additional Inherited Members
Protected Attributes inherited from ULEnum
int	id

const char *	stringID

const char *	displayString

Static Protected Attributes inherited from ULEnum
static ULHashTable< ULString, uluint32 >	featureNameToRunTimeID

Detailed Description

An enhanced enumerated type used as return values throughout ULAPI to represent various error conditions.

See ULEnum for a discussion of enhanced enumerated types in ULAPI.

Constructor & Destructor Documentation

ULError::ULError ( )

Default constructor.

ULError::ULError ( const ULError & other )

Copy constructor.

ULError::ULError ( int otherID )

Constructor by id.

ULError::ULError ( const char * otherStringID )

Constructor.

Parameters

[in] otherStringID The string ID corresponding to the ULError value this ULError should be copied from.

ULError::~ULError ( )

virtual

Destructor.

Member Function Documentation

void ULError::clear ( )

virtual

Sets this ULError object to its default state.

Reimplemented from ULEnum.

int ULError::getEnumeratedValueCount ( )

static

Returns: the number of distinct enumerated values of this type.

const ULError & ULError::getInstance ( int id )

static

Returns: the statically allocated instance of this type corresponding to the specified integer id.

Parameters

[in] id the desired integer id.

bool ULError::operator!= ( const ULError & other ) const

Inequality operator.

bool ULError::operator!= ( const char * stringID ) const

Inequality operator.

Returns: true if the specified string is not equal to this ULError's string ID.

Parameters

[in] stringID The string to compare to this object's string ID.

bool ULError::operator< ( const ULError & other ) const

Comparison operator.

Returns: true if this ULError's integer ID is strictly less than other's.

Parameters

[in] other The other ULError object.

bool ULError::operator< ( const char * stringID ) const

Comparison operator.

Returns: true if this ULError's integer ID is is strictly less the integer ID of the ULError value corresponding to the specified string ID.

Parameters

[in] stringID The string ID.

ULError & ULError::operator= ( const ULError & other )

Assignment operator.

Returns: a reference to this ULError object.

ULError & ULError::operator= ( int otherID )

Assignment operator.

Parameters

[in] otherID The ID of the enumerated value of ULError to assign to this ULError.

ULError & ULError::operator= ( const char * otherStringID )

Assignment operator.

Returns: a reference to this ULError object.

Parameters

[in] stringID If stringID is the string ID of one of the ULError enumerated values, then this object is copied from that ULError. Otherwise, this object is assigned the default value.

bool ULError::operator== ( const ULError & other ) const

Equality operator.

bool ULError::operator== ( const char * stringID ) const

Equality operator.

Returns: true if the specified string is equal to this ULError's string ID.

Parameters

[in] stringID The string to compare to this object's string ID.

Member Data Documentation

const ULError & ULError::DataSourceAttachFailed = ULError("datasourceattach", "Data source failed to attach")

static

const ULError & ULError::DataSourceOpenFailed = ULError("datasourceopen", "Data source failed to open")

static

const ULError & ULError::ICUError = ULError("icu", "ICU error")

static

const ULError & ULError::InvalidDataSourceVersion = ULError("invaliddatasourceversion", "Data source has an invalid version")

static

const ULError & ULError::InvalidID = ULError("invalidid", "Invalid ID")

static

const ULError & ULError::InvalidIterator = ULError("invaliditerator", "Invalid iterator")

static

const ULError & ULError::InvalidLanguageFile = ULError("invalidlanguagefile", "Invalid language file")

static

const ULError & ULError::InvalidName = ULError("invalidname", "Invalid name")

static

const ULError & ULError::MemoryAllocationFailed = ULError("memory", "Memory allocation failed")

static

const ULError & ULError::NoError = ULError("noerror", "No error")

static

const ULError & ULError::NoMatch = ULError("nomatch", "No match")

static

const ULError & ULError::NoSuchObject = ULError("nosuchobject", "No such object")

static

const ULError & ULError::NotImplemented = ULError("notimplemented", "Not implemented")

static

const ULError & ULError::ObjectUninitialized = ULError("uninitialized", "Object uninitialized")

static

const ULError & ULError::OperationCancelled = ULError("operationcancelled", "Operation cancelled")

static

const ULError & ULError::TooManyMatches = ULError("toomanymatches", "Too many matches")

static

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

ulerror.h
ulerror.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation