API  0.9.7
 All Classes Files Functions Variables Macros Groups Pages
CPException Class Reference

Used to implement exception handling (creating & raising). More...

#import <CPException.h>

+ Inheritance diagram for CPException:

Instance Methods

(id) - copy
 
(CPString- description
 
(void) - encodeWithCoder:
 
(id) - initWithCoder:
 
(id) - initWithName:reason:userInfo:
 
(BOOL) - isEqual:
 
(CPString- name
 
(void) - raise
 
(CPString- reason
 
(CPDictionary- userInfo
 

Class Methods

(id) + alloc
 
(CPException+ exceptionWithName:reason:userInfo:
 
(void) + raise:format:
 
(void) + raise:reason:
 

Instance Variables

CPString message
 
CPString name
 

Detailed Description

Used to implement exception handling (creating & raising).

An example of throwing an exception in Objective-J:
// some code here...
if (input == nil)
    [CPException raise:"MyException" reason:"You didn't do something right."];
// code that gets executed if no exception was raised

Definition at line 2 of file CPException.h.

Method Documentation

+ (id) alloc
implementation

Definition at line 54 of file CPException.j.

- (id) copy
implementation

Provided by category CPException(CPCopying).

Definition at line 175 of file CPException.j.

- (CPString) description
implementation

Returns the exception's reason.

Definition at line 147 of file CPException.j.

- (void) encodeWithCoder: (CPCoder aCoder
implementation

Encodes the exception's data into a coder.

Parameters
aCoderthe coder to which the data will be written

Provided by category CPException(CPCoding).

Definition at line 209 of file CPException.j.

+ (CPException) exceptionWithName: (CPString aName
reason: (CPString aReason
userInfo: (CPDictionary aUserInfo 
implementation

Creates an exception with a name, reason and user info.

Parameters
aNamethe name of the exception
aReasonthe reason the exception occurred
aUserInfoa dictionary containing information about the exception
Returns
the new exception

Definition at line 94 of file CPException.j.

- (id) initWithCoder: (CPCoder aCoder
implementation

Initializes the exception with data from a coder.

Parameters
aCoderthe coder from which to read the exception data
Returns
the initialized exception

Provided by category CPException(CPCoding).

Definition at line 193 of file CPException.j.

- (id) initWithName: (CPString aName
reason: (CPString aReason
userInfo: (CPDictionary aUserInfo 
implementation

Initializes the exception.

Parameters
aNamethe name of the exception
aReasonthe reason for the exception
aUserInfoa dictionary containing information about the exception
Returns
the initialized exception

Definition at line 106 of file CPException.j.

- (BOOL) isEqual: (id)  anObject
implementation

Definition at line 160 of file CPException.j.

- (CPString) name
implementation

Returns the name of the exception.

Definition at line 123 of file CPException.j.

- (void) raise
implementation

Raises the exception and causes the program to go to the exception handler.

Definition at line 155 of file CPException.j.

+ (void) raise: (CPString aName
format: (CPString aFormat
,   ... 
implementation

Raises an exception with a name and a formatted reason.

Parameters
aNamethe name of the exception to raise
aFormatthe reason for the exception in sprintf style
...the arguments for the sprintf format

Definition at line 77 of file CPException.j.

+ (void) raise: (CPString aName
reason: (CPString aReason 
implementation

Raises an exception with a name and reason.

Parameters
aNamethe name of the exception to raise
aReasonthe reason for the exception

Definition at line 66 of file CPException.j.

- (CPString) reason
implementation

Returns the reason for the exception.

Definition at line 131 of file CPException.j.

- (CPDictionary) userInfo
implementation

Returns data containing info about the receiver.

Definition at line 139 of file CPException.j.

Instance Variable Documentation

- (CPString) message
protected

Definition at line 6 of file CPException.h.

- (CPString) name
protected

Definition at line 5 of file CPException.h.


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