Core.TypeCast.ConverterException Class Reference

The Exception-type which is raised exclusively by the Converter<TIn,TOut> Library More...

Collaboration diagram for Core.TypeCast.ConverterException:

Public Member Functions
	ConverterException (ConverterCause cause, string message=null)
	Initializes a new instance of the ConverterException class. Requires a ConverterCause and optional user message . More...
	ConverterException (ConverterCause cause, Exception innerException)
	Initializes a new instance of the ConverterException class. Requires a ConverterCause and innerException message More...
	ConverterException (ConverterCause cause, Exception innerException, string message)
	Initializes a new instance of the ConverterException class. Requires a ConverterCause an innerException and an exception message More...
virtual string	GetMessage ()
	Override this method for custom formatting of the unformatted exception Exception.Message More...
override string	ToString ()
	A string representation of the current exception. More...

Properties
ConverterCause	Cause [get, set]
	Gets or sets the exception's ConverterCause, which is set through the parameterized exception constructor ConverterException(ConverterCause, string) More...
override string	Message [get]
	Gets the exception message. More...

Detailed Description

The Exception-type which is raised exclusively by the Converter<TIn,TOut> Library

See also

ConverterCause

Definition at line 19 of file ConverterException.cs.

Constructor & Destructor Documentation

Core.TypeCast.ConverterException.ConverterException	(	ConverterCause	cause,
		string	message = null
	)

Initializes a new instance of the ConverterException class. Requires a ConverterCause and optional user message .

Parameters

cause	The coded reason for the Exception
message	The message for the Exception. If left empty, the description of the cause will be used as exception message

Definition at line 30 of file ConverterException.cs.

            : this(cause, null, message ?? cause.GetDescription())
        {
        }

Core.TypeCast.ConverterException.ConverterException	(	ConverterCause	cause,
		Exception	innerException
	)

Initializes a new instance of the ConverterException class. Requires a ConverterCause and innerException message

Parameters

cause	The coded reason for the Exception
innerException	The wrapped exception within the ConverterException

Definition at line 41 of file ConverterException.cs.

            : this(cause, innerException, cause.GetDescription())
        {
        }

Core.TypeCast.ConverterException.ConverterException	(	ConverterCause	cause,
		Exception	innerException,
		string	message
	)

Initializes a new instance of the ConverterException class. Requires a ConverterCause an innerException and an exception message

Parameters

cause	The coded reason for the Exception of the value ConverterCause
innerException	The wrapped exception within the ConverterException
message	The message for the Exception

Definition at line 53 of file ConverterException.cs.

            : base(message, innerException)
        {
            this.Cause = cause;
        }

Member Function Documentation

virtual string Core.TypeCast.ConverterException.GetMessage ( )

virtual

Override this method for custom formatting of the unformatted exception Exception.Message

Returns

The string containing the formatted exception message

Definition at line 71 of file ConverterException.cs.

        {
            return this.Cause.GetType().Name + " '" + this.Cause + "': " + this.Cause.GetDescription();
        }

override string Core.TypeCast.ConverterException.ToString

(

)

A string representation of the current exception.

Returns

Returns a string representation of GetMessage concatenated to the underlying Exception.ToString method.

Definition at line 93 of file ConverterException.cs.

        {
            return this.GetMessage() + Environment.NewLine + base.ToString();
        }

Property Documentation

ConverterCause Core.TypeCast.ConverterException.Cause

getset

Gets or sets the exception's ConverterCause, which is set through the parameterized exception constructor ConverterException(ConverterCause, string)

Returns

The enumeration value for the raised Exception of the type ConverterCause

To get a detailed description of the value, use EnumExtension.GetDescription(Enum,string)

Definition at line 65 of file ConverterException.cs.

override string Core.TypeCast.ConverterException.Message

get

Gets the exception message.

Definition at line 80 of file ConverterException.cs.

---

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

• TypeCast/ConverterException.cs