This exception is thrown when an invalid argument occurs. More...

#include <ArgumentException.hpp>

Inheritance diagram for Arp::Base::Commons::Exceptions::ArgumentException:

Public Member Functions
	ArgumentException (const ArgumentException &arg)
	Default copy constructor.

	ArgumentException (ArgumentException &&arg) noexcept
	Default move constructor.

ArgumentException &	operator= (const ArgumentException &arg)
	Default copy-assignment operator.

ArgumentException &	operator= (ArgumentException &&arg) noexcept
	Default move-assignment operator.

	~ArgumentException (void) override
	Default destructor.

template<typename... Args>
	ArgumentException (const char *message, const Args &... args)
	Creates an ArgumentException with message. More...

	ArgumentException (String &&message)
	Constructs an ArgumentException instance. More...

	ArgumentException (const String &message)
	Constructs an ArgumentException instance. More...

	ArgumentException (String &&message, const Exception &innerException)
	Constructs an ArgumentException instance. More...

	ArgumentException (const String &message, const Exception &innerException)
	Constructs an ArgumentException instance. More...

Impl &	GetImpl (void)
	For internal use only.

const Impl &	GetImpl (void) const

Public Member Functions inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
const Stacktrace &	GetStacktrace (void) const
	Gets the stackstrace of the point of creating this exception. More...

const StacktraceItems &	GetStacktraceItems (void) const
	Gets the stackstrace items of the point of creating this exception. More...

Public Member Functions inherited from Arp::Base::Core::Exception
	Exception (const Exception &arg)
	Default copy constructor.

	Exception (Exception &&arg) noexcept
	Default move constructor.

Exception &	operator= (const Exception &arg)
	Default copy-assignment operator.

Exception &	operator= (Exception &&arg) noexcept
	Default move-assignment operator.

virtual	~Exception (void)
	Default destructor.

	Exception (void)
	Constructs an empty instance of class Exception.

template<typename... Args>
	Exception (const char *message, Args &&... args)
	Constructs an instance of class Exception. More...

	Exception (const String &message)
	Constructs an instance of class Exception. More...

	Exception (String &&message)
	Constructs an instance of class Exception. More...

	Exception (const String &message, const Exception &innerException)
	Constructs an instance of class Exception. More...

	Exception (String &&message, const Exception &innerException)
	Constructs an instance of class Exception. More...

const String &	GetMessage (void) const
	Gets the error message of this exception. More...

ExceptionTypeId	GetTypeId (void) const
	Gets the type ID of this exception. More...

TypeCode	GetTypeCode (void) const
	Gets the type code of this exception. More...

bool	HasInnerException (void) const
	Determines if this exception has an inner exception. More...

const Exception &	GetInnerException (void) const
	Gets the inner exception of this exception. More...

String	ToString (void) const
	This operation should be used for logging and returns a reasonable description of the exception cause. More...

virtual Exception::Ptr	Clone (void) const
	This operation clones this instance polymorphically as a deep copy. More...

virtual String	Format (bool withInnerException) const
	Formats this exception using the given indent level. More...

Impl &	GetImpl (void)
	For internal use only.

const Impl &	GetImpl (void) const

Static Public Member Functions
template<class T >
static ArgumentException	Create (const char *paramName, const T &paramValue)
	Creates an ArgumentException using a default message. More...

template<class T >
static ArgumentException	Create (const char paramName, const T &paramValue, const char message)
	Creates an ArgumentException using a default message. More...

template<class T >
static ArgumentException	Create (const char *paramName, const T &paramValue, const Exception &innerException)
	Creates an ArgumentException using a default message. More...

Protected Member Functions
	ArgumentException (ExceptionTypeId typeId, String &&message, StackCounter stackCounter)
	Creates an ArgumentException instance, used by derived classes only. More...

	ArgumentException (ExceptionTypeId typeId, const String &message, StackCounter stackCounter)
	Creates an ArgumentException instance, used by derived classes only. More...

	ArgumentException (ExceptionTypeId typeId, String &&message, const Exception &innerException, StackCounter stackCounter)
	Creates an ArgumentException instance, used by derived classes only. More...

	ArgumentException (ExceptionTypeId typeId, const String &message, const Exception &innerException, StackCounter stackCounter)
	Creates an ArgumentException instance, used by derived classes only. More...

Exception::Ptr	Clone (void) const override
	This operation clones this instance polymorphically as a deep copy. More...

Protected Member Functions inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
	CommonExceptionBase (const CommonExceptionBase &arg)
	Default copy constructor.

	CommonExceptionBase (CommonExceptionBase &&arg) noexcept
	Default move constructor.

CommonExceptionBase &	operator= (const CommonExceptionBase &arg)
	Default copy-assignment operator.

CommonExceptionBase &	operator= (CommonExceptionBase &&arg) noexcept
	Default move-assignment operator.

	~CommonExceptionBase (void) override
	Default destructor.

	CommonExceptionBase (ExceptionTypeId typeId, String &&message, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

	CommonExceptionBase (ExceptionTypeId typeId, const String &message, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

	CommonExceptionBase (ExceptionTypeId typeId, String &&message, const Exception &innerException, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

	CommonExceptionBase (ExceptionTypeId typeId, const String &message, const Exception &innerException, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

String	Format (bool withInnerException) const override
	Formats this exception using the given indent level. More...

Protected Member Functions inherited from Arp::Base::Core::Exception
	Exception (ExceptionTypeId typeId, String &&message)
	Used by derived exception classes. More...

	Exception (ExceptionTypeId typeId, const String &message)
	Used by derived exception classes. More...

	Exception (ExceptionTypeId typeId, String &&message, const Exception &innerException)
	Used by derived exception classes. More...

	Exception (ExceptionTypeId typeId, const String &message, const Exception &innerException)
	Used by derived exception classes. More...

	Exception (String &&message, const Exception::Ptr &innerExceptionPtr)
	DEPRECATED. More...

String	Format (int indentLevel, bool withInnerException) const
	DEPRECATED. More...

virtual uint32	GetTypeCodeInternal (void) const
	DEPRECATED. More...

Additional Inherited Members
Public Types inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
using	StackCounter = Arp::Base::Commons::Runtime::StackCounter

using	Stacktrace = Arp::Base::Commons::Runtime::Stacktrace

using	StacktraceItems = Arp::Base::Commons::Runtime::Stacktrace::Items

Public Types inherited from Arp::Base::Core::Exception
using	Ptr = std::unique_ptr< Exception >
	The smart pointer type of this class.

using	TypeCode = std::underlying_type< Arp::Base::Core::ExceptionTypeId >::type
	The integral type of the type code.

Detailed Description

This exception is thrown when an invalid argument occurs.

Constructor & Destructor Documentation

◆ ArgumentException() [1/9]

template<typename... Args>

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	const char *	message,
		const Args &...	args
	)

inlineexplicit

Creates an ArgumentException with message.

Template Parameters

...Args The variadic template types.

Parameters

message	The format message.
...args	The arguments of the format message.

◆ ArgumentException() [2/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException ( String && message )

Constructs an ArgumentException instance.

Parameters

message The exception message.

◆ ArgumentException() [3/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException ( const String & message )

Constructs an ArgumentException instance.

Parameters

message The exception message.

◆ ArgumentException() [4/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	String &&	message,
		const Exception &	innerException
	)

Constructs an ArgumentException instance.

Parameters

message	The exception message.
innerException	The inner exception.

◆ ArgumentException() [5/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	const String &	message,
		const Exception &	innerException
	)

Constructs an ArgumentException instance.

Parameters

message	The exception message.
innerException	The inner exception.

◆ ArgumentException() [6/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	ExceptionTypeId	typeId,
		String &&	message,
		StackCounter	stackCounter
	)

protected

Creates an ArgumentException instance, used by derived classes only.

Parameters

typeId	The exception type id of the derived exception
message	The exception message.
stackCounter	The stack counter,

◆ ArgumentException() [7/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	ExceptionTypeId	typeId,
		const String &	message,
		StackCounter	stackCounter
	)

protected

Creates an ArgumentException instance, used by derived classes only.

Parameters

typeId	The exception type id of the derived exception
message	The exception message.
stackCounter	The stack counter,

◆ ArgumentException() [8/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	ExceptionTypeId	typeId,
		String &&	message,
		const Exception &	innerException,
		StackCounter	stackCounter
	)

protected

Creates an ArgumentException instance, used by derived classes only.

Parameters

typeId	The exception type id of the derived exception
message	The exception message.
innerException	The inner exception.
stackCounter	The stack counter,

◆ ArgumentException() [9/9]

Arp::Base::Commons::Exceptions::ArgumentException::ArgumentException	(	ExceptionTypeId	typeId,
		const String &	message,
		const Exception &	innerException,
		StackCounter	stackCounter
	)

protected

Creates an ArgumentException instance, used by derived classes only.

Parameters

typeId	The exception type id of the derived exception
message	The exception message.
innerException	The inner exception.
stackCounter	The stack counter,

Member Function Documentation

◆ Clone()

Exception::Ptr Arp::System::Commons::ArgumentException::Clone ( void ) const

overrideprotectedvirtual

This operation clones this instance polymorphically as a deep copy.

This operation clones this instance polymorpically as a deep copy.

Never ever forget to override this operation in any derived exception class.

Reimplemented from Arp::Base::Core::Exception.

Reimplemented in Arp::Base::Commons::Exceptions::ArgumentNullException, Arp::Base::Commons::Exceptions::ArgumentOutOfRangeException, Arp::System::Commons::InvalidDataConnectionException, and Arp::System::Commons::KeyNotFoundException.

◆ Create() [1/3]

template<class T >

ArgumentException Arp::Base::Commons::Exceptions::ArgumentException::Create	(	const char *	paramName,
		const T &	paramValue
	)

inlinestatic

Creates an ArgumentException using a default message.

Template Parameters

T	The type of the invalid parameter.

Parameters

paramName	The name of the invalid parameter.
paramValue	The value of the invalid parameter.

Returns: The resulting ArgumentException.

◆ Create() [2/3]

template<class T >

ArgumentException Arp::Base::Commons::Exceptions::ArgumentException::Create	(	const char *	paramName,
		const T &	paramValue,
		const char *	message
	)

inlinestatic

Creates an ArgumentException using a default message.

Template Parameters

T	The type of the invalid parameter.

Parameters

paramName	The name of the invalid parameter.
paramValue	The value of the invalid parameter.
message	An additional message..

Returns: The resulting ArgumentException.

◆ Create() [3/3]

template<class T >

ArgumentException Arp::Base::Commons::Exceptions::ArgumentException::Create	(	const char *	paramName,
		const T &	paramValue,
		const Exception &	innerException
	)

inlinestatic

Creates an ArgumentException using a default message.

Template Parameters

T	The type of the invalid parameter.

Parameters

paramName	The name of the invalid parameter.
paramValue	The value of the invalid parameter.
innerException	An innter exception.

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

Arp/Base/Commons/Exceptions/ArgumentException.hpp
Arp/Base/Commons/Exceptions/ArgumentException.cpp
Arp/System/Commons/Exceptions/ArgumentException.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArgumentException() [1/9]

◆ ArgumentException() [2/9]

◆ ArgumentException() [3/9]

◆ ArgumentException() [4/9]

◆ ArgumentException() [5/9]

◆ ArgumentException() [6/9]

◆ ArgumentException() [7/9]

◆ ArgumentException() [8/9]

◆ ArgumentException() [9/9]

Member Function Documentation

◆ Clone()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]