PLCnext API Documentation  21.0.0.35466
ArgumentNullException.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Commons/Exceptions/ArgumentException.hpp"
9 #include <type_traits>
10 
11 namespace Arp { namespace System { namespace Commons
12 {
13 
16 {
17 public: // construction/destruction
18  template<typename... Args>
19  ArgumentNullException(const char* message, const Args& ... args);
20  ArgumentNullException(const String& message);
21  ArgumentNullException(String&& message);
22  ArgumentNullException(const String& message, const Exception& innerException);
23  ArgumentNullException(String&& message, Exception&& innerException);
24  ArgumentNullException(const ArgumentNullException& arg) = default;
25  ArgumentNullException(ArgumentNullException&& arg) = default;
26  virtual ~ArgumentNullException(void) = default;
27 
28 public: // static factory methods
29  static ArgumentNullException Create(const char* paramName);
30  static ArgumentNullException Create(const char* paramName, const Exception& innerException);
31 
32 protected: // overridden operations
33  Exception::Ptr Clone(void)const override;
34 
35 private: // deleted methods
36  ArgumentNullException& operator=(const ArgumentNullException& arg) = delete;
37 
38 private:
39  static const char* const defaultMessage;
40 };
41 
43 // inline methods of class ArgumentNullException
44 
46 template<typename... Args>
47 inline ArgumentNullException::ArgumentNullException(const char* message, const Args& ... args)
48  : ArgumentException(ExceptionTypeId::ArgumentNull, String::Format(message, args...))
49 {
50 }
51 
54  : ArgumentException(ExceptionTypeId::ArgumentNull, message)
55 {
56 }
57 
60  : ArgumentException(ExceptionTypeId::ArgumentNull, message)
61 {
62 }
63 
65 inline ArgumentNullException::ArgumentNullException(const String& message, const Exception& innerException)
66  : ArgumentException(ExceptionTypeId::ArgumentNull, std::move(message), std::move(innerException))
67 {
68 }
69 
72  : ArgumentException(ExceptionTypeId::ArgumentNull, std::move(message), std::move(innerException))
73 {
74 }
75 
78 {
79  return ArgumentNullException(defaultMessage, paramName);
80 }
81 
83 inline ArgumentNullException ArgumentNullException::Create(const char* paramName, const Exception& innerException)
84 {
85  return ArgumentNullException(String::Format(defaultMessage, paramName), innerException);
86 }
87 
88 }}} // end of namesapce Arp::System::Commons
static ArgumentNullException Create(const char *paramName)
Creates an ArgumentNullException instance using a default message text.
Definition: ArgumentNullException.hpp:77
String Format(int indentLevel, bool withInnerException) const override
Formats this exception using the given indent level.
Namespace of the C++ standard library
This exception is used when an invalid <null> argument occurs.
Definition: ArgumentNullException.hpp:15
ArgumentNullException(const char *message, const Args &... args)
Constructs an ArgumentNullException instance.
Definition: ArgumentNullException.hpp:47
std::shared_ptr< Exception > Ptr
The smart pointer tpye of this class.
Definition: Exception.hpp:19
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:14
This exception is used when an invalid argument occurs.
Definition: ArgumentException.hpp:14
static SelfType Format(const SelfType &format, const Args &... args)
Formats the format string using the .NET/Python syntax with the given variadic arguments.
Definition: BasicString.hxx:1482
Root namespace for the PLCnext API
System components used by the System, Device, Plc or Io domains.
Exception::Ptr Clone(void) const override
Clones this instance.
This is the base class of all Arp exception classes.
Definition: Exception.hpp:15