SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform
Class Exception

ThrowableType
   |
   +-Exception

Implemented in:
Platform.Exception.h
Direct Known Subclasses:
IOException, ParseException, TaskCreateException

class Exception:
public ThrowableType

Represents a generic form of throwable type concept. This is the base class for all the exceptions in the platform. Two user-defined properties (code and message) are provided to hold basic information about the occured error. Deriving types may enhance this information and provide own implementation of toString for proper formatting.

Field Summarycollapse
protected const String errorMessage
          An immutable user-defined message property describing the exception.

Constructor Summarycollapse
Exception()
          Constructs a new exception with code 0 and message "Exception".
Exception(const String& message)
          Constructs a new exception with code 0 and a specified message.

Method Summarycollapse
const String& message() const
          Retrieves the message property describing this exception.
String toString() const
          Returns a string representation of this exception.

 

Field Detail

errorMessage

protected const String errorMessage

An immutable user-defined message property describing the exception.

 

Constructor Detail

Exception[inline]

Exception()

Constructs a new exception with code 0 and message "Exception".


Exception[inline]

Exception(const String& message)

Constructs a new exception with code 0 and a specified message.

Parameters:
message - a user-defined string describing the exception

 

Method Detail

message[inline]

const String& message() const

Retrieves the message property describing this exception.

Returns:
a user-defined string describing this exception

toString[virtual, inline]

String toString() const

Returns a string representation of this exception. The default format returns the message field of the exception.

Returns:
a string representation of this exception


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND