argument_out_of_range_exception.h

Go to the documentation of this file.

 
#pragma once
#include "argument_exception.h"
#include "literals.h"
 
namespace xtd {
  class argument_out_of_range_exception : public argument_exception {
  public:
    
    explicit argument_out_of_range_exception(const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(default_message(), stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const std::error_code& error, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, error, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const xtd::string& help_link, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, help_link, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const std::error_code& error, const xtd::string& help_link, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, error, help_link, stack_frame) {}
    explicit argument_out_of_range_exception(const std::exception& inner_exception, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(default_message(), inner_exception, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const std::exception& inner_exception, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, inner_exception, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const std::exception& inner_exception, const std::error_code& error, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, inner_exception, error, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const std::exception& inner_exception, const xtd::string& help_link, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, inner_exception, help_link, stack_frame) {}
    explicit argument_out_of_range_exception(const xtd::string& message, const std::exception& inner_exception, const std::error_code& error, const xtd::string& help_link, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) : argument_exception(message, inner_exception, error, help_link, stack_frame) {}
    
    argument_out_of_range_exception(const argument_out_of_range_exception&) = default;
    argument_out_of_range_exception& operator =(const argument_out_of_range_exception&) = default;
    
    
    template <typename value_t>
    static void throw_if_equal(const value_t& value, const value_t& other, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value == other) throw argument_out_of_range_exception {string::format("value ('{0}') must not be equal to `{1}`. (Parameter '{2}')\nActual value was {0}.", value, other, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_less_than(const value_t& value, const value_t& other, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value < other) throw argument_out_of_range_exception {string::format("value ('{0}') must be greater than or equal to `{1}`. (Parameter '{2}')\nActual value was {0}.", value, other, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_less_than_or_equal(const value_t& value, const value_t& other, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value <= other) throw argument_out_of_range_exception {string::format("value ('{0}') must be greater than `{1}`. (Parameter '{2}')\nActual value was {0}.", value, other, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_greater_than(const value_t& value, const value_t& other, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value > other) throw argument_out_of_range_exception {string::format("value ('{0}') must be less than or equal to `{1}`. (Parameter '{2}')\nActual value was {0}.", value, other, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_greater_than_or_equal(const value_t& value, const value_t& other, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value >= other) throw argument_out_of_range_exception {string::format("value ('{0}') must be less than `{1}`. (Parameter '{2}')\nActual value was {0}.", value, other, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_negative(const value_t& value, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value < static_cast<value_t>(0)) throw argument_out_of_range_exception {string::format("value ('{0}') must be a non-negative value. (Parameter '{1}')\nActual value was {0}.", value, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_negative_or_zero(const value_t& value, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value <= static_cast<value_t>(0)) throw argument_out_of_range_exception {string::format("value ('{0}') must be a non-negative and non-zero value. (Parameter '{1}')\nActual value was {0}.", value, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_not_equal(const value_t& value, const value_t& other, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value != other) throw argument_out_of_range_exception {string::format("value ('{0}') must be equal to `{1}`. (Parameter '{2}')\nActual value was {0}.", value, other, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_positive(const value_t& value, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value > static_cast<value_t>(0)) throw argument_out_of_range_exception {string::format("value ('{0}') must be a non-positive value. (Parameter '{1}')\nActual value was {0}.", value, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_positive_or_zero(const value_t& value, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value >= static_cast<value_t>(0)) throw argument_out_of_range_exception {string::format("value ('{0}') must be a non-positive and non-zero value. (Parameter '{1}')\nActual value was {0}.", value, param_name, stack_frame)};}
    template <typename value_t>
    static void throw_if_zero(const value_t& value, const xtd::string& param_name = xtd::string::empty_string, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {if (value == static_cast<value_t>(0)) throw argument_out_of_range_exception {string::format("value ('{0}') must be a non-zero value. (Parameter '{1}')\nActual value was {0}.", value, param_name, stack_frame)};}
 
  private:
    const char* default_message() const noexcept {return "Specified argument is out of range of valid values."_t;}
  };
}