PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Arp::Base::Commons::Exceptions::ArgumentNullException Class Reference

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

#include <ArgumentNullException.hpp>

Inheritance diagram for Arp::Base::Commons::Exceptions::ArgumentNullException:
Inheritance graph

Public Member Functions

 ArgumentNullException (const ArgumentNullException &arg)
 Default copy constructor.
 
 ArgumentNullException (ArgumentNullException &&arg) noexcept
 Default move constructor.
 
ArgumentNullExceptionoperator= (const ArgumentNullException &arg)
 Default copy-assignment operator.
 
ArgumentNullExceptionoperator= (ArgumentNullException &&arg) noexcept
 Default move-assignment operator.
 
 ~ArgumentNullException (void) override
 Default destructor.
 
template<typename... Args>
 ArgumentNullException (const char *message, const Args &... args)
 Creates an ArgumentNullException with message. More...
 
 ArgumentNullException (String &&message)
 Constructs an ArgumentNullException instance. More...
 
 ArgumentNullException (const String &message)
 Constructs an ArgumentNullException instance. More...
 
 ArgumentNullException (String &&message, const Exception &innerException)
 Constructs an ArgumentNullException instance. More...
 
 ArgumentNullException (const String &message, const Exception &innerException)
 Constructs an ArgumentNullException instance. More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 
- Public Member Functions inherited from Arp::Base::Commons::Exceptions::ArgumentException
 ArgumentException (const ArgumentException &arg)
 Default copy constructor.
 
 ArgumentException (ArgumentException &&arg) noexcept
 Default move constructor.
 
ArgumentExceptionoperator= (const ArgumentException &arg)
 Default copy-assignment operator.
 
ArgumentExceptionoperator= (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 StacktraceGetStacktrace (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.
 
Exceptionoperator= (const Exception &arg)
 Default copy-assignment operator.
 
Exceptionoperator= (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 StringGetMessage (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 ExceptionGetInnerException (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

static ArgumentNullException Create (const char *paramName)
 Creates an ArgumentNullException using a default message. More...
 
static ArgumentNullException Create (const char *paramName, const char *message)
 Creates an ArgumentNullException using a default message. More...
 
static ArgumentNullException Create (const char *paramName, const Exception &innerException)
 Creates an ArgumentNullException using a default message. More...
 
- Static Public Member Functions inherited from Arp::Base::Commons::Exceptions::ArgumentException
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

 ArgumentNullException (ExceptionTypeId typeId, String &&message, StackCounter stackCounter)
 Creates an ArgumentNullException instance, used by derived classes only. More...
 
 ArgumentNullException (ExceptionTypeId typeId, const String &message, StackCounter stackCounter)
 Creates an ArgumentNullException instance, used by derived classes only. More...
 
 ArgumentNullException (ExceptionTypeId typeId, String &&message, const Exception &innerException, StackCounter stackCounter)
 Creates an ArgumentNullException instance, used by derived classes only. More...
 
 ArgumentNullException (ExceptionTypeId typeId, const String &message, const Exception &innerException, StackCounter stackCounter)
 Creates an ArgumentNullException instance, used by derived classes only. More...
 
Exception::Ptr Clone (void) const override
 This operation clones this instance polymorphically as a deep copy.This operation clones this instance polymorpically as a deep copy. More...
 
- Protected Member Functions inherited from Arp::Base::Commons::Exceptions::ArgumentException
 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.
 
CommonExceptionBaseoperator= (const CommonExceptionBase &arg)
 Default copy-assignment operator.
 
CommonExceptionBaseoperator= (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 null argument occurs.

Constructor & Destructor Documentation

◆ ArgumentNullException() [1/9]

template<typename... Args>
Arp::Base::Commons::Exceptions::ArgumentNullException::ArgumentNullException ( const char *  message,
const Args &...  args 
)
inlineexplicit

Creates an ArgumentNullException with message.

Template Parameters
...ArgsThe variadic template types.
Parameters
messageThe format message.
...argsThe arguments of the format message.

◆ ArgumentNullException() [2/9]

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

Constructs an ArgumentNullException instance.

Parameters
messageThe exception message.

◆ ArgumentNullException() [3/9]

Arp::Base::Commons::Exceptions::ArgumentNullException::ArgumentNullException ( const String message)

Constructs an ArgumentNullException instance.

Parameters
messageThe exception message.

◆ ArgumentNullException() [4/9]

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

Constructs an ArgumentNullException instance.

Parameters
messageThe exception message.
innerExceptionThe inner exception.

◆ ArgumentNullException() [5/9]

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

Constructs an ArgumentNullException instance.

Parameters
messageThe exception message.
innerExceptionThe inner exception.

◆ ArgumentNullException() [6/9]

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

Creates an ArgumentNullException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
stackCounterThe stack counter,

◆ ArgumentNullException() [7/9]

Arp::Base::Commons::Exceptions::ArgumentNullException::ArgumentNullException ( ExceptionTypeId  typeId,
const String message,
StackCounter  stackCounter 
)
protected

Creates an ArgumentNullException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
stackCounterThe stack counter,

◆ ArgumentNullException() [8/9]

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

Creates an ArgumentNullException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
innerExceptionThe inner exception.
stackCounterThe stack counter,

◆ ArgumentNullException() [9/9]

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

Creates an ArgumentNullException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
innerExceptionThe inner exception.
stackCounterThe stack counter,

Member Function Documentation

◆ Clone()

Exception::Ptr Arp::System::Commons::ArgumentNullException::Clone ( void  ) const
overrideprotectedvirtual

This operation clones this instance polymorphically as a deep copy.This operation clones this instance polymorpically 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::Commons::Exceptions::ArgumentException.

◆ Create() [1/3]

ArgumentNullException Arp::Base::Commons::Exceptions::ArgumentNullException::Create ( const char *  paramName)
inlinestatic

Creates an ArgumentNullException using a default message.

Parameters
paramNameThe name of the invalid parameter.
Returns
The resulting ArgumentNullException.

◆ Create() [2/3]

ArgumentNullException Arp::Base::Commons::Exceptions::ArgumentNullException::Create ( const char *  paramName,
const char *  message 
)
inlinestatic

Creates an ArgumentNullException using a default message.

Parameters
paramNameThe name of the invalid parameter.
messageAn additional message..
Returns
The resulting ArgumentNullException.

◆ Create() [3/3]

ArgumentNullException Arp::Base::Commons::Exceptions::ArgumentNullException::Create ( const char *  paramName,
const Exception innerException 
)
inlinestatic

Creates an ArgumentNullException using a default message.

Parameters
paramNameThe name of the invalid parameter.
innerExceptionAn innter exception.

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