PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Properties | List of all members
PreEmptive.Analytics.Common.ExceptionInfo Class Reference

Class for handling exception information. More...

Public Member Functions

 ExceptionInfo ()
 Constructor for ExceptionInfo. More...
 
 ExceptionInfo (ExceptionType type, Exception exception=null, string contact=null, string comment=null, string message=null)
 Constructor for ExceptionInfo. More...
 

Static Public Member Functions

static ExceptionInfo Caught (Exception exception=null, string contact=null, string comment=null, string message=null)
 Creates a new exception that is of type ExceptionType.Caught. More...
 
static ExceptionInfo Caught (string name, string message=null, string callstack=null, string callstackregex=null, string contact=null, string comment=null)
 Creates a new exception that is of type ExceptionType.Caught. More...
 
static ExceptionInfo Uncaught (Exception exception=null, string contact=null, string comment=null, string message=null)
 Creates a new exception that is of type ExceptionType.Uncaught. More...
 
static ExceptionInfo Uncaught (string name, string message=null, string callstack=null, string callstackregex=null, string contact=null, string comment=null)
 Creates a new exception that is of type ExceptionType.Uncaught. More...
 
static ExceptionInfo Thrown (Exception exception=null, string contact=null, string comment=null, string message=null)
 Creates a new exception that is of type ExceptionType.Thrown. More...
 
static ExceptionInfo Thrown (string name, string message=null, string callstack=null, string callstackregex=null, string contact=null, string comment=null)
 Creates a new exception that is of type ExceptionType.Thrown. More...
 
static Exception CreateException (string name, string exceptionmessage, string callstack, string callstackregex)
 Creates an Exception object with the provided information. More...
 

Properties

Exception Exception [get, set]
 The exception object. More...
 
ExceptionType ExceptionType [get, set]
 The type of the exception. More...
 
string Message [get, set]
 A human readable message that describes the condition. More...
 
string Contact [get, set]
 Contact information for the end user (e.g. an email address). More...
 
string Comment [get, set]
 A comment string provided by the end user. More...
 

Detailed Description

Class for handling exception information.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.ExceptionInfo.ExceptionInfo ( )

Constructor for ExceptionInfo.

PreEmptive.Analytics.Common.ExceptionInfo.ExceptionInfo ( ExceptionType  type,
Exception  exception = null,
string  contact = null,
string  comment = null,
string  message = null 
)

Constructor for ExceptionInfo.

Parameters
typeThe type of the exception.
exceptionThe exception object.
contactContact information for the end user (e.g. an email address).
commentA comment string provided by the end user.
messageA human readable message that describes the condition.

Member Function Documentation

static ExceptionInfo PreEmptive.Analytics.Common.ExceptionInfo.Caught ( Exception  exception = null,
string  contact = null,
string  comment = null,
string  message = null 
)
static

Creates a new exception that is of type ExceptionType.Caught.

Parameters
exceptionThe exception object.
contactContact information for the end user (e.g. an email address).
commentA comment string provided by the end user.
messageA human readable message that describes the condition.
Returns
The resulting ExceptionInfo.
static ExceptionInfo PreEmptive.Analytics.Common.ExceptionInfo.Caught ( string  name,
string  message = null,
string  callstack = null,
string  callstackregex = null,
string  contact = null,
string  comment = null 
)
static

Creates a new exception that is of type ExceptionType.Caught.

Parameters
nameThe name of the exception.
messageA human readable message that describes the condition.
callstackThe callstack representing the state when the exception occurred.
callstackregexThe regular expression that should be used to parse the callstack.
contactA comment string provided by the end user.
commentA comment string provided by the end user.
Returns
The resulting ExceptionInfo.
static Exception PreEmptive.Analytics.Common.ExceptionInfo.CreateException ( string  name,
string  exceptionmessage,
string  callstack,
string  callstackregex 
)
static

Creates an Exception object with the provided information.

Parameters
nameThe name of the exception.
exceptionmessageA human readable message that describes the condition.
callstackThe callstack representing the state when the exception occurred.
callstackregexThe regular expression that should be used to parse the callstack.
Returns
The resulting Exception object.
static ExceptionInfo PreEmptive.Analytics.Common.ExceptionInfo.Thrown ( Exception  exception = null,
string  contact = null,
string  comment = null,
string  message = null 
)
static

Creates a new exception that is of type ExceptionType.Thrown.

Parameters
exceptionThe exception object.
contactContact information for the end user (e.g. an email address).
commentA comment string provided by the end user.
messageA human readable message that describes the condition.
Returns
The resulting ExceptionInfo.
static ExceptionInfo PreEmptive.Analytics.Common.ExceptionInfo.Thrown ( string  name,
string  message = null,
string  callstack = null,
string  callstackregex = null,
string  contact = null,
string  comment = null 
)
static

Creates a new exception that is of type ExceptionType.Thrown.

Parameters
nameThe name of the exception.
messageA human readable message that describes the condition.
callstackThe callstack representing the state when the exception occurred.
callstackregexThe regular expression that should be used to parse the callstack.
contactA comment string provided by the end user.
commentA comment string provided by the end user.
Returns
The resulting ExceptionInfo.
static ExceptionInfo PreEmptive.Analytics.Common.ExceptionInfo.Uncaught ( Exception  exception = null,
string  contact = null,
string  comment = null,
string  message = null 
)
static

Creates a new exception that is of type ExceptionType.Uncaught.

Parameters
exceptionThe exception object.
contactContact information for the end user (e.g. an email address).
commentA comment string provided by the end user.
messageA human readable message that describes the condition.
Returns
The resulting ExceptionInfo.
static ExceptionInfo PreEmptive.Analytics.Common.ExceptionInfo.Uncaught ( string  name,
string  message = null,
string  callstack = null,
string  callstackregex = null,
string  contact = null,
string  comment = null 
)
static

Creates a new exception that is of type ExceptionType.Uncaught.

Parameters
nameThe name of the exception.
messageA human readable message that describes the condition.
callstackThe callstack representing the state when the exception occurred.
callstackregexThe regular expression that should be used to parse the callstack.
contactA comment string provided by the end user.
commentA comment string provided by the end user.
Returns
The resulting ExceptionInfo.

Property Documentation

string PreEmptive.Analytics.Common.ExceptionInfo.Comment
getset

A comment string provided by the end user.

string PreEmptive.Analytics.Common.ExceptionInfo.Contact
getset

Contact information for the end user (e.g. an email address).

Exception PreEmptive.Analytics.Common.ExceptionInfo.Exception
getset

The exception object.

ExceptionType PreEmptive.Analytics.Common.ExceptionInfo.ExceptionType
getset

The type of the exception.

string PreEmptive.Analytics.Common.ExceptionInfo.Message
getset

A human readable message that describes the condition.


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