ArgumentOutOfRangeException.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Commons/Exceptions/ArgumentException.hpp"
 
namespace Arp::Base::Commons::Exceptions
{
 
class ARP_BASE_COMMONS_EXPORT ArgumentOutOfRangeException : public ArgumentException
{
public: // Impl forward declaration
    class Impl;
 
public: // construction
    template<typename... Args>
    explicit ArgumentOutOfRangeException(const char* message, const Args& ... args);
    explicit ArgumentOutOfRangeException(String&& message);
    explicit ArgumentOutOfRangeException(const String& message);
    ArgumentOutOfRangeException(String&& message, const Exception& innerException);
    ArgumentOutOfRangeException(const String& message, const Exception& innerException);
 
    // canonical construction/destruction/assignment
    ArgumentOutOfRangeException(const ArgumentOutOfRangeException& arg);
    ArgumentOutOfRangeException(ArgumentOutOfRangeException&& arg)noexcept;
    ArgumentOutOfRangeException& operator=(const ArgumentOutOfRangeException& arg);
    ArgumentOutOfRangeException& operator=(ArgumentOutOfRangeException&& arg)noexcept;
    ~ArgumentOutOfRangeException(void) override ;
 
protected: // construction
    ArgumentOutOfRangeException(ExceptionTypeId typeId, String&& message, StackCounter stackCounter);
    ArgumentOutOfRangeException(ExceptionTypeId typeId, const String& message, StackCounter stackCounter);
    ArgumentOutOfRangeException(ExceptionTypeId typeId, String&& message, const Exception& innerException, StackCounter stackCounter);
    ArgumentOutOfRangeException(ExceptionTypeId typeId, const String& message, const Exception& innerException, StackCounter stackCounter);
 
public: // static factory operations
    template<class T>
    static ArgumentOutOfRangeException Create(const char* paramName, const T& paramValue);
    template<class T>
    static ArgumentOutOfRangeException Create(const char* paramName, const T& paramValue, const char* message);
    template<class T>
    static ArgumentOutOfRangeException Create(const char* paramName, const T& paramValue, const Exception& innerException);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
protected: // overridden operations
    Exception::Ptr  Clone(void)const override ;
 
private: // static factory methods
    static ArgumentOutOfRangeException  CreateImpl(const char* paramName, const String& paramValue, StackCounter stackCounter);
    static ArgumentOutOfRangeException  CreateImpl(const char* paramName, const String& paramValue, const char* message, StackCounter stackCounter);
    static ArgumentOutOfRangeException  CreateImpl(const char* paramName, const String& paramValue, const Exception& innerException, StackCounter stackCounter);
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
// inline methods of class ArgumentException
 
template<typename... Args>
inline ArgumentOutOfRangeException::ArgumentOutOfRangeException(const char* message, const Args& ... args)
    : ArgumentOutOfRangeException(ExceptionTypeId::ArgumentNull, String::Format(message, args...), StackCounter())
{
}
 
template<class T>
inline ArgumentOutOfRangeException ArgumentOutOfRangeException::Create(const char* paramName, const T& paramValue)
{
    return CreateImpl(paramName, String::Format("{}", paramValue), StackCounter());
}
 
template<class T>
inline ArgumentOutOfRangeException ArgumentOutOfRangeException::Create(const char* paramName, const T& paramValue, const char* message)
{
    return CreateImpl(paramName, String::Format("{}", paramValue), message, StackCounter());
}
 
template<class T>
inline ArgumentOutOfRangeException ArgumentOutOfRangeException::Create(const char* paramName, const T& paramValue, const Exception& innerException)
{
    return CreateImpl(paramName, String::Format("{}", paramValue), innerException, StackCounter());
}
 
} // end of namespace Arp::Base::Commons::Exceptions
 
namespace Arp {
// Import exception into Arp namespace as Arp::System::Commons library does
using Arp::Base::Commons::Exceptions::ArgumentOutOfRangeException;
} // end of namespace Arp
// template specialization of ArgumentOutOfRangeException formatter
template<> struct fmt::formatter<Arp::Base::Commons::Exceptions::ArgumentOutOfRangeException> : public fmt::ostream_formatter {};