PLCnext API Documentation 23.6.0.37
AccessDeniedException.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/System/Commons/Exceptions/Io/IoException.hpp"
9
10namespace Arp { namespace System { namespace Commons { namespace Io
11{
12
15{
16public: // construction/destruction
17 template<typename... Args>
18 AccessDeniedException(const char* message, const Args& ... args);
19 AccessDeniedException(const String& message);
21 AccessDeniedException(const String& message, const Exception& innerException);
22 AccessDeniedException(String&& message, Exception&& innerException);
23 AccessDeniedException(const AccessDeniedException& arg) = default;
24 AccessDeniedException(AccessDeniedException&& arg)noexcept = default;
25 virtual ~AccessDeniedException(void) = default;
26
27public: // static factory methods
28 static AccessDeniedException Create(const String& path);
29 static AccessDeniedException Create(const String& path, const Exception& innerException);
30 static AccessDeniedException Create(const String& sourcePath, const String& destinationPath);
31 static AccessDeniedException Create(const String& sourcePath, const String& destinationPath, const Exception& innerException);
32
33protected: // overridden operations
34 Exception::Ptr Clone(void)const override;
35
36private: // deleted methods
37 AccessDeniedException& operator=(const AccessDeniedException& arg) = delete;
38
39private:
40 static const char* const defaultMessage;
41 static const char* const defaultMessage2;
42};
43
45// inline methods of class AccessDeniedException
46
48template<typename... Args>
49inline AccessDeniedException::AccessDeniedException(const char* message, const Args& ... args)
50 : IoException(ExceptionTypeId::IoAccessDenied, String::Format(message, args...))
51{
52}
53
56 : IoException(ExceptionTypeId::IoAccessDenied, message)
57{
58}
59
62 : IoException(ExceptionTypeId::IoAccessDenied, std::move(message))
63{
64}
65
67inline AccessDeniedException::AccessDeniedException(const String& message, const Exception& innerException)
68 : IoException(ExceptionTypeId::IoAccessDenied, message, innerException)
69{
70}
71
74 : IoException(ExceptionTypeId::IoAccessDenied, std::move(message), std::move(innerException))
75{
76}
77
80{
81 return AccessDeniedException(String::Format(defaultMessage, path));
82}
83
85inline AccessDeniedException AccessDeniedException::Create(const String& path, const Exception& innerException)
86{
87 return AccessDeniedException(String::Format(defaultMessage, path), innerException);
88}
89
91inline AccessDeniedException AccessDeniedException::Create(const String& sourcePath, const String& destinationPath)
92{
93 return AccessDeniedException(String::Format(defaultMessage2, sourcePath, destinationPath));
94}
95
97inline AccessDeniedException AccessDeniedException::Create(const String& sourcePath, const String& destinationPath, const Exception& innerException)
98{
99 return AccessDeniedException(String::Format(defaultMessage2, sourcePath, destinationPath), innerException);
100}
101
102}}}} // end of namesapce Arp::System::Commons::Io
This is the base class of all Arp exception classes.
Definition: Exception.hpp:16
std::shared_ptr< Exception > Ptr
The smart pointer tpye of this class.
Definition: Exception.hpp:19
This exception is used when a requested file does not exist.
Definition: AccessDeniedException.hpp:15
static AccessDeniedException Create(const String &path)
Creates an AccessDeniedException instance using a default message text.
Definition: AccessDeniedException.hpp:79
Exception::Ptr Clone(void) const override
Clones this instance.
AccessDeniedException(const char *message, const Args &... args)
Constructs an AccessDeniedException instance.
Definition: AccessDeniedException.hpp:49
This is the base class of all IO exceptions.
Definition: IoException.hpp:15
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:1493
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:15
Root namespace for the PLCnext API
Namespace of the C++ standard library