PLCnext API Documentation 25.0.2.69
AccessDeniedException.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
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
54}}}} // end of namesapce Arp::System::Commons::Io
55
57// template specialization of AccessDeniedException formatter
58template<> struct fmt::formatter<Arp::System::Commons::Io::AccessDeniedException> : public fmt::ostream_formatter {};
This is the base class of all Arp exception classes.
Definition: Exception.hpp:21
std::unique_ptr< Exception > Ptr
The smart pointer type of this class.
Definition: Exception.hpp:27
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
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.cpp:46
Exception::Ptr Clone(void) const override
This operation clones this instance polymorpically as a deep copy.
Definition: AccessDeniedException.cpp:16
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
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:15
Root namespace for the PLCnext API