libUTL++
utl::Exception Class Reference

Root of UTL++ exception class hierarchy. More...

#include <Exception.h>

Inheritance diagram for utl::Exception:

Public Member Functions

 Exception (const char *name, Object *object)
 Constructor. More...
 
 Exception (const char *name, const Object &object)
 Constructor. More...
 
virtual void copy (const Object &rhs)
 Copy another Exception.
 
virtual void dump (Stream &os) const
 Dump a description of the exception to the given stream.
 
const Stringname () const
 Get the name. More...
 
const StringnamePtr () const
 Get name pointer. More...
 
void setName (const char *name)
 Set the name. More...
 
Objectobject () const
 Get the associated object. More...
 
ObjecttakeObject ()
 Take the associated object. More...
 
void setObject (Object *object)
 Set the object to the given object. More...
 
void setObject (const Object &object)
 Set the object to a copy of the given object. More...
 
- Public Member Functions inherited from utl::Object
void clear ()
 Revert to initial state. More...
 
virtual int compare (const Object &rhs) const
 Compare with another object. More...
 
virtual void vclone (const Object &rhs)
 Make an exact copy of another instance. More...
 
virtual void steal (Object &rhs)
 "Steal" the internal representation from another instance. More...
 
virtual void dump (Stream &os, uint_t level=uint_t_max) const
 Dump a human-readable representation of self to the given output stream. More...
 
void dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
 Front-end for dump() that prints the object's class name. More...
 
virtual const ObjectgetKey () const
 Get the key for this object. More...
 
bool hasKey () const
 Determine whether or not the object has a key. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 Get the proxied object (= self if none). More...
 
virtual size_t hash (size_t size) const
 Get the hash code for the object. More...
 
bool _isA (const RunTimeClass *runTimeClass) const
 Determine whether self's class is a descendent of the given class. More...
 
virtual String toString () const
 Return a string representation of self. More...
 
 operator String () const
 Conversion to String. More...
 
size_t allocatedSize () const
 Get the total allocated size of this object. More...
 
virtual size_t innerAllocatedSize () const
 Get the "inner" allocated size. More...
 
virtual void addOwnedIt (const class FwdIt *it) const
 Notify self that it owns the given iterator. More...
 
virtual void removeOwnedIt (const class FwdIt *it) const
 Notify self that the given owned iterator has been destroyed. More...
 
bool operator< (const Object &rhs) const
 Less-than operator. More...
 
bool operator<= (const Object &rhs) const
 Less-than-or-equal-to operator. More...
 
bool operator> (const Object &rhs) const
 Greater-than operator. More...
 
bool operator>= (const Object &rhs) const
 Greater-than-or-equal-to operator. More...
 
bool operator== (const Object &rhs) const
 Equal-to operator. More...
 
bool operator!= (const Object &rhs) const
 Unequal-to operator. More...
 
void serializeIn (Stream &is, uint_t mode=ser_default)
 Serialize from an input stream. More...
 
void serializeOut (Stream &os, uint_t mode=ser_default) const
 Serialize to an output stream. More...
 
virtual void serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize to or from a stream. More...
 
void serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
 Serialize a boxed object to an output stream. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from utl::Object
static ObjectserializeInNullable (Stream &is, uint_t mode=ser_default)
 Serialize a nullptr-able object from an input stream. More...
 
static void serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
 Serialize a nullptr-able object to an output stream. More...
 
static void serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize a nullptr-able object to or from a stream. More...
 
static ObjectserializeInBoxed (Stream &is, uint_t mode=ser_default)
 Serialize a boxed object from an input stream. More...
 
static void serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize a boxed object to or from a stream. More...
 

Detailed Description

Root of UTL++ exception class hierarchy.

Author
Adam McKee

Definition at line 109 of file Exception.h.

Constructor & Destructor Documentation

◆ Exception() [1/2]

utl::Exception::Exception ( const char *  name,
Object object 
)

Constructor.

Parameters
nameexception name
objectcontains information about the exception

◆ Exception() [2/2]

utl::Exception::Exception ( const char *  name,
const Object object 
)

Constructor.

Parameters
nameexception name
objectcontains information about the exception

Member Function Documentation

◆ name()

const String& utl::Exception::name ( ) const
inline

Get the name.

Definition at line 140 of file Exception.h.

References ASSERTD.

◆ namePtr()

const String* utl::Exception::namePtr ( ) const
inline

Get name pointer.

Definition at line 148 of file Exception.h.

◆ setName()

void utl::Exception::setName ( const char *  name)

Set the name.

◆ object()

Object* utl::Exception::object ( ) const
inline

Get the associated object.

Definition at line 158 of file Exception.h.

◆ takeObject()

Object* utl::Exception::takeObject ( )
inline

Take the associated object.

Definition at line 165 of file Exception.h.

References utl::deInit(), and utl::init().

◆ setObject() [1/2]

void utl::Exception::setObject ( Object object)

Set the object to the given object.

◆ setObject() [2/2]

void utl::Exception::setObject ( const Object object)

Set the object to a copy of the given object.


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